C/C++

2023-11-08

养成好习惯—规范编码方法

参考:麦子学院-C语言程序设计及快速入门

为什么规范编码很重要

5个方面很大程序上决定了一份代码的质量高低。来看一下这5方面:
1、编码标准:这个想必都很清楚,每个公司几乎都有一份编码遫脆,类命名、包命名、代码风格之类的东西都属于其中。
2、代码重复:顾名思义就是重复的代码,如果你的代码中有大量的重复代码,你就要考虑是否将重复的代码提取出来,封装成一个公共的方法或者组件。
3、代码覆盖率:测试代码能运行到的代码比率,你的代码经过了单元测试了吗?是不是每个方法都进行了测试,代码覆盖率是多少?这关系到你的代码的功能性和稳定性。
4、依赖项分析:你的代码依赖关系怎么样?耦合关系怎么样?是否有循玕依赖?是否符合高内聚低耦合的原则?通过依赖项分析可以辨别一二。
5、复杂度分析:以前有人写的程序嵌套了10层if else你信吗?圈复杂度之高,让人难以阅读。通过复杂度分析可以揪出这些代码,要相信越优秀的代码,越容易读懂。
1提高代码的可读行
2提高编码质量
3提高代码的健壮性
代码的可扩展性,可移植性,可兼容性…
可读性好的规范代码,可以让面试官对你刮目相看

推荐书籍:

C语言编程规范(华为、林锐、MISRAC)
代码大全

规范编码的重要性

规范编码,从Tab键开始

1 养成用Tab排版的好习惯
2 如何让代码更整齐
·程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。
·{}之内的代码块在‘{’右边数格处左对齐

代码行的规范写法

1 一行代码只做一件事
2 if,for,while,do语句自占一行
3 出现长行怎么办?
每行不超过70-80个字符
从优先级低的地方拆分(或操作较低)

空行和空格,让你的代码更赏心悦目

空格

【规则 2-3-1】关键字之后要留空格。象 const、virtual、inline、case 等关键字之后 至少要留一个空格,否则无法辨析关键字。象 if、for、while 等关键字之后应留一个 空格再跟左括号‘(’,以突出关键字。
【规则 2-3-2】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。
【规则 2-3-3】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。
【规则 2-3-4】‘,’之后要留空格,如 Function(x, y, z)。如果‘;’不是一行的结束 符号,其后要留空格,如 for (initialization; condition; update)。
【规则 2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符, 如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元 操作符的前后应当加空格。
【规则 2-3-6】一元操作符如“!”、“~”、“++”、“–”、“&”(地址运算符)等前后不 加空格。
【规则 2-3-7】象“[ ]”、“.”、“->”这类操作符前后不加空格。
【建议 2-3-1】对于表达式比较长的 for 语句和 if 语句,为了紧凑起见可以适当地去 掉一些空格,如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))

空行

【规则 2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。
【规则 2-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。

谈谈C代码的注释

注释符

C 语言的注释符为“//”。C++语言中,程序块的注释常采用“//”,放在实现的前面,行注释一般采用“//…”。

位置

注释通常用于 :
(1)版本、版权声明;
(2)函数接口说明;
(3)重要的代码行或段落提示,核心代码,关键代码;
虽然注释有助于理解代码,但注意不可过多地使用注释。

好代码,取名很重要

1为什么命名很重要
在这里插入图片描述
2编码命名的几条常见规则
·标识符应当直观且可以拼读,可望文知意,不必进行“解码”。
·标识符的长度应当符合“min-length && max-information”原则
·程序中不要出现仅靠大小写区分的相似的标识符
·变量的名字应当使用“名词”或者“形容词+名词”
·全局函数的名字应当使用“动词”或者“动词+名词”
·用正确的反义词组命名具有互斥意义的变量或相反动作的函数等
·尽量避免名字中出现数字编号
在这里插入图片描述

商业代码基本要求,关于版权和版本声明

1 为何要谈版权和版本
2 版权和版本声明的格式
在这里插入图片描述

规范编码进阶及写代码的一些小技巧

参考:C语言编程规范(华为、林锐、MISRAC)
1函数设计方法及规范
2修饰符的选择
3 指针的使用(内存管理)

技巧

一些提高编码效率,减少编码结误率的小技巧
1编码写好框架,再填充内容
2== 符号的编码技巧
对比较等判断条件:左侧写常量右侧写变量
3声明的变量记得初始化

Tips1:匈牙利命名法

引自:百度百科
匈牙利命名法是一种编程时的命名规范。基本原则是:变量名=属性+类型+对象描述,其中每一对象的名称都要求有明确含义,可以取对象名字全称或名字的一部分。要基于容易记忆容易理解的原则。保证名字的连贯性是非常重要的。

例子

举例来说,表单的名称为form,那么在匈牙利命名法中可以简写为frm,则当表单变量名称为Switchboard时,变量全称应该为 frmSwitchboard。这样可以很容易从变量名看出Switchboard是一个表单,同样,如果此变量类型为标签,那么就应命名成 lblSwitchboard。可以看出,匈牙利命名法非常便于记忆,而且使变量名非常清晰易懂,这样,增强了代码的可读性,方便各程序员之间相互交流代码。

历史背景

据说这种命名法是一位叫 Charles Simonyi 的匈牙利程序员发明的,后来他在微软待了几年,于是这种命名法就通过微软的各种产品和文档资料向世界传播开了。大部分程序员不管自己使用什么软件进行开发,或多或少都使用了这种命名法。这种命名法的出发点是把变量名按:属性+类型+对象描述的顺序组合起来,以使程序员作变量时对变量的类型和其它属性有直观的了解
下面是HN变量命名规范。

属性部分:

g_ 全局变量
c_  常量
m_  c++类成员变量
s_  静态变量

类型部分:

数组 a
指针 p
函数 fn
无效 v
句柄 h
长整型 l
布尔 b
浮点型(有时也指文件) f
双字  dw
字符串  sz
短整型  n
双精度浮点 d
计数 c(通常用cnt)
字符 ch(通常用c)
整型 i(通常用n)
字节 by
字 w
实型 r
无符号 u

描述部分:

最大 Max
最小 Min
初始化 Init
临时变量 T(或Temp)
源对象 Src
目的对象 Dest

举例

hwnd : h 是类型描述,表示句柄, wnd 是变量对象描述,表示窗口,所以 hwnd 表示窗口句柄;
pfnEatApple : pfn 是类型描述,表示指向函数的指针, EatApple 是变量对象描述,所以它表示指向 EatApple 函数的函数指针变量。
g_cch : g_ 是属性描述,表示全局变量,c 和 ch 分别是计数类型和字符类型,一起表示变量类型,这里忽略了对象描述,所以它表示一个对字符进行计数的全局变量。
上面就是HN命名法的一般规则。

总结

MFC、句柄、控件及结构的命名规范:
Windows类型 样本变量;MFC类 样本变量
HWND hWnd; CWnd* pWnd;
HDLG hDlg; CDialog* pDlg;
HDC hDC; CDC* pDC;
HGDIOBJ hGdiObj; CGdiObject* pGdiObj;
HPEN hPen; CPen* pPen;
HBRUSH hBrush; CBrush* pBrush;
HFONT hFont; CFont* pFont;
HBITMAP hBitmap; CBitmap* pBitmap;
HPALETTE hPaltte; CPalette* pPalette;
HRGN hRgn; CRgn* pRgn;
HMENU hMenu; CMenu* pMenu;
HWND hCtl; CState* pState;
HWND hCtl; CButton* pButton;
HWND hCtl; CEdit* pEdit;
HWND hCtl; CListBox* pListBox;
HWND hCtl; CComboBox* pComboBox;
HWND hCtl; CScrollBar* pScrollBar;
HSZ hszStr; CString pStr;
POINT pt; CPoint pt;
SIZE size; CSize size;
RECT rect; CRect rect;

一般前缀命名规范:

前缀&类型&实例
C 类或结构 CDocument,CPrintInfo
m_ 成员变量 m_pDoc,m_nCustomers

变量命名规范:

前缀&类型&描述&实例
ch char 8位字符 chGrade
ch TCHAR 如果_UNICODE定义,则为16位字符 chName
b BOOL 布尔值 bEnable
n int 整型(其大小依赖于操作系统) nLength
u UINT 无符号值(其大小依赖于操作系统) uHeight
w WORD 16位无符号值 wPos
l LONG 32位有符号整型 lOffset
dw DWORD 32位无符号整型 dwRange
p * 指针 pDoc
lp FAR* 远指针 lpszName
lpsz LPSTR 32位字符串指针 lpszName
lpsz LPCSTR 32位常量字符串指针 lpszName
lpsz LPCTSTR 如果_UNICODE定义,则为32位常量字符串指针 lpszName
h handle Windows对象句柄 hWnd
lpfn callback 指向CALLBACK函数的远指针

前缀_符号类型:

前缀_符号类型实例&范围
IDR_ 不同类型的多个资源共享标识 IDR_MAIINFRAME 1~0x6FFF
IDD_ 对话框资源 IDD_SPELL_CHECK 1~0x6FFF
HIDD_ 对话框资源的Help上下文 HIDD_SPELL_CHECK 0x20001~0x26FF
IDB_ 位图资源 IDB_COMPANY_LOGO 1~0x6FFF
IDC_ 光标资源 IDC_PENCIL 1~0x6FFF
IDI_ 图标资源 IDI_NOTEPAD 1~0x6FFF
ID_ 来自菜单项或工具栏的命令 ID_TOOLS_SPELLING 0x8000~0xDFFF
HID_ 命令Help上下文 HID_TOOLS_SPELLING 0x18000~0x1DFFF
IDP_ 消息框提示 IDP_INVALID_PARTNO 8~0xDEEF
HIDP_ 消息框Help上下文 HIDP_INVALID_PARTNO 0x30008~0x3DEFF
IDS_ 串资源 IDS_COPYRIGHT 1~0x7EEF
IDC_ 对话框内的控件 IDC_RECALC 8~0xDEEF

Microsoft MFC宏命名规范:

名称&类型
_AFXDLL 唯一的动态连接库(Dynamic Link Library,DLL)版本
_ALPHA 仅编译DEC Alpha处理器
_DEBUG 包括诊断的调试版本
_MBCS 编译多字节字符集
_UNICODE 在一个应用程序中打开Unicode
AFXAPI MFC提供的函数
CALLBACK 通过指针回调的函数

库标识符命名法:

标识符&值和含义
u ANSI(N)或Unicode(U)
d 调试或发行:D = 调试;忽略标识符为发行。

静态库版本命名规范:

库&描述
NAFXCWD.LIB 调试版本:MFC静态连接库
NAFXCW.LIB 发行版本:MFC静态连接库
UAFXCWD.LIB 调试版本:具有Unicode支持的MFC静态连接库
UAFXCW.LIB 发行版本:具有Unicode支持的MFC静态连接库

动态连接库命名规范:

名称&类型
_AFXDLL 唯一的动态连接库(DLL)版本
WINAPI Windows所提供的函数
Windows.h中新的命名规范:
类型&定义描述
WINAPI 使用在API声明中的FAR PASCAL位置,如果正在编写一个具有导出API人口点的DLL,则可以在自己的API中使用该类型
CALLBACK 使用在应用程序回叫例程,如窗口和对话框过程中的FAR PASCAL的位置
LPCSTR 与LPSTR相同,只是LPCSTR用于只读串指针,其定义类似(const char FAR*)
UINT 可移植的无符号整型类型,其大小由主机环境决定(对于Windows NT和Windows 9x为32位);它是unsigned int的同义词
LRESULT 窗口程序返回值的类型
LPARAM 声明lParam所使用的类型,lParam是窗口程序的第四个参数
WPARAM 声明wParam所使用的类型,wParam是窗口程序的第三个参数
LPVOID 一般指针类型,与(void *)相同,可以用来代替LPSTR

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

C/C++ 的相关文章

  • 万字长文详解特斯拉自动驾驶体系(感知/规控/标注/仿真)

    作者 和君 编辑 禾隐记 点击下方卡片 关注 自动驾驶之心 公众号 ADAS巨卷干货 即可获取 点击进入 自动驾驶之心 全栈算法 技术交流群 汽车革命的上半场是电动化 下半场是智能化 电动化只是改变了汽车的动力供给方式 并没有改变汽车的性质
  • ElasticSearch系列十二:掌握ES使用Java API

    一 Java连接ElasticSearch6 x版本 可整合到spring中
  • 洛谷 P1885 Moo

    P1885 Moo 题目描述 奶牛Bessie最近在学习字符串操作 它用如下的规则逐一的构造出新的字符串 S 0 moo S 1 S 0 m ooo S 0 moo m ooo moo moomooomoo S 2 S 1 m oooo S
  • AcWing 1381. 阶乘

    题目 N 的阶乘 记作 N 是指从 1 到 N 包括 1 和 N 的所有整数的乘积 阶乘运算的结果往往都非常的大 现在 给定数字 N 请你求出 N 的最右边的非零数字是多少 例如 5 1 2 3 4 5 120 所以 5 的最右边的非零数字
  • 安全开发-JS应用&原生开发&JQuery库&Ajax技术&加密编码库&断点调试&逆向分析&元素属性操作

    文章目录 JS原生开发 文件上传 变量 对象 函数 事件 JS导入库开发 登录验证 JQuery库 Ajax技术 JS导入库开发 编码加密 逆向调试 JS原生开发 文件上传 变量 对象 函数 事件 1 布置前端页面 2 JS获取提交数据 3
  • 超详细Hyperledger Fabric2.3.3开发教程

    最近一直在总结Hyperledger Fabric的开发教程 主要包括 1 什么是Hyperledger 区块链 Hyperledger Fabric 01 超级账本介绍 2 Fabric 2 3 3安装教程 区块链 Hyperledger
  • LeetCode 15. 三数之和

    文章目录 1 排序 双指针 2 对上面代码加剪枝 题目链接 https leetcode cn problems 3sum 1 排序 双指针 思路如下 对数组进行排序 枚举第一个数 n u m s i

随机推荐

  • Vue的生命周期

    推荐一些文章 超详细vue生命周期解析 详解 vue生命周期 vue之生命周期 详细 vue生命周期钩子函数详解 Vue生命周期 11个钩子函数
  • 流媒体传输协议详解之---RTSP认证

    Rtsp认证主要分为两种 基本认证 basic authentication 和摘要认证 digest authentication 基本认证是http 1 0提出的认证方案 其消息传输不经过加密转换因此存在严重的安全隐患 摘要认证是htt
  • 刷脸支付大战的气氛弥漫各处

    人工智能 关于移动支付 这些或新或老的名词 再一次随着产品的落地冲入人们的眼前 从外观上看 这台机器不过iPad大小 似乎平平无奇 但实际使用起来却异常轻松 在香港国际机场1号客运大厅Duty Zero免税店里 智东西记者看到 顾客只要把脸
  • 评估计算recall、precision、AP、F1、mAP(PyTorch-YOLOv3代码解析二)

    目标检测评估计算 utils py 代码github地址 https github com eriklindernoren PyTorch YOLOv3 1 检测的评估函数 reference https github com erikli
  • C++ String类编写

    1 h文件 ifndef STR H define STR H include
  • angular-ui-select 支持搜索的 下拉选择框 的使用

    github地址 https github com angular ui ui select 默认支持所有唯一性字段的匹配 可以配置只有一种 通过channelList filter description select search 或者
  • 线性回归模型及K-score归一化方法Python3实现杂文

    Python3 线性回归模型及K score归一化方法实现 前言 本文是博主参考吴恩达的机器学习课程记录的杂文笔记 主要内容是线性回归的代码实现和K score归一化方法的代码实现 以及线性回归的主要公式内容 鉴于博主水平 如有错误 请帮忙
  • 基于CentOS7.6编译Redis6.0.4 ,gcc版本过低出现:make: *** [all] Error 2问题

    一 CentOS7 6 环境编译Redis6 0 4 编译命令 异常 二 问题描述 原因是Linux系统gcc版本过低 yum安装的gcc是4 8 5的 需要升级gcc 如下 yum y install centos release scl
  • Java 简介

    前言 既然要学习一门技术 那么就先来了解下它的历史 我们为什么要使用它 以及我们能用它来干啥 历史背景 1990 年代初 Sun 公司的詹姆斯 高斯林等人为了实现电视机 电话 闹钟等家用电器的控制和通信 开发了一套用于设置在家用电器等小型系
  • C++11新特性大全+使用方法

    前言 C 这门编程语言的历史可以追溯至 1979 年 当时的 Bjarne Stroustrup C 之父 后续简称 Stroustrup 还在使用 Simula 语言进行开发工作 1998 年 C 标准委员会发布了第一版 C 标准 并将其
  • introduction of race conditions in RS flip-flops

    原文链接 https electronics stackexchange com questions 155949 what is race condition in flip flops A race condition is a tim
  • DBeaver执行SQL脚本文件

    1 右键库名 点击工具 gt 执行脚本 2 在弹出窗口中选择输入文件 并修改Extra command args default character set utf8 防止中文乱码 点击开始按钮 不加这个参数会报错 Data too lon
  • iOS 跳转到系统的设置界面

    iOS8打开设置界面 NSURL url NSURL URLWithString prefs root LOCATION SERVICES if UIApplication sharedApplication canOpenURL url
  • Agent系统

    Agent是分布式人工智能和现代计算机 通信技术发展的必然结果 给Agent下一个确切的定义很困难 一般都是根据自己的研究领域和需求进行定义 最经典和广为授受的是Wooldridge等人的 弱定义 和 强定义 104 1 弱定义 Agent
  • 什么是 XML?使用IntelliJ IDEA 创建一个简单的 xml 文件

    目录 什么是 XML XML 和 HTML 之间的差异 创建一个 xml 文件 什么是 XML XML 指可扩展标记语言 EXtensible Markup Language XML 是一种很像HTML的标记语言 XML 的设计宗旨是传输数
  • JAVA abstract修饰符、抽象类、模板模式

    abstract只能修饰类和方法 并且不能与final同时出现 抽象类 只有抽象类可以包含抽象方法 但它不能创建实例 抽象类能定义初始化块和构造器 它的初始化块和构造器是为了子类的调用 抽象类也能包含主函数入口 抽象类可以声明类变量但不能创
  • 【Google最新成果】使用新的物理模拟引擎加速强化学习

    深度强化学习实验室 官网 http www neurondance com 论坛 http deeprl neurondance com 来源 GoogleAI Blog 上一篇文章我们介绍了Google AI 开放的 最新 如何降低深度强
  • APP数据埋点分类方式

    1 数据埋点的重要性 在现实工作中 数据的整体流程为 数据生产 数据采集 数据处理 数据分析和挖掘 数据可视化 其中 数据采集是很重要的一个环节 数据采集得全不全 对不对 直接决定数据广度和质量 影响后续所有的环节 如果采集的数据维度很少
  • 使用云服务器CentOS7.6搭建个人网站

    为扩展个人知识面以及满足我对网站建设的好奇心 以及在课程的推动下 我开始搭建属于自己的个人网站 一 实验材料 硬件 云服务器 可用虚拟机代替 软件 VMware VScode Pycharm Xshell Xftp 二实验过程 1 使用Xs
  • C/C++

    文章目录 养成好习惯 规范编码方法 为什么规范编码很重要 推荐书籍 规范编码的重要性 规范编码 从Tab键开始 代码行的规范写法 空行和空格 让你的代码更赏心悦目 空格 空行 谈谈C代码的注释 注释符 位置 好代码 取名很重要 商业代码基本