C/C++|物联网开发入门+项目实战|C语言基础|养成好习惯---规范编码方法 -学习笔记（5）

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

参考：麦子学院-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