C++ 编码规范总结

  具有良好编码规范的代码就是在保证高质量完成需求的同时具备良好的可读性、可维护性。

注释的编写规范

文件头的注释

  该部分主要涉及到作者名、文件名称、文件名称、生成日期等

函数的注释

  1.对于关键函数，必须写上注释，说明函数的用途。
  2.对于函数中的特别参数，需要说明参数的目的，由谁负责释放等…
  3.一般函数的注释要写在代码之前。
  4.尚未完善的代码或需要进一步完善的代码，应加上 //TODO…
  5.每个else,endif 要给出行末注释。
  6.对于调试部分的代码，要加上注释 //only for DEBUG， 需要引起关注的代码，加上注释 //NOTE。
  7.对于较大的代码块结尾（for,while,do 等），可加上 // end for|while|do。

命名规则

 1.原则
  1.1 .同一性：在编写一个子模块或派生类的时候，要遵循其基类或整体模块的命名风格，保持命名风格在这个模块中的同一性。
  1.2 .标识符组成：标识符使用英文单词或其组合，要求直观且可拼读，可望文知意，用词应当准确。
  1.3 .避免在不同级别的作用域中重名：程序中不要出现名字完全相同的局部变量和全局变量，尽管两者的作用域不同不会发生语法错误，但容易误解。
  1.4 .避免过于相似：不要出现仅靠大小写区分的相似的标识符，例如‘a’， ‘A’。
  1.5 .避免名字中出现数字编号：如function1,function2… 除非逻辑上需要编号。
 2.成员变量
  2.1 .成员变量使用m为前缀。
  2.1 .避免出现和匈牙利混合的命名规则如mpBuffer名称，用mBuffer即可。
 3. 局部变量
  3.1. 循环变量和简单变量采用小写字符串即可，例如， int i
   3.2. 指针变量用p打头， 如 auto* pBufer
 4. 全局变量
  4.1. 全局变量用g_ 为前缀。
  5.类名
   5.1 .类和对象名为名词。
   5.2 .实现行为的类成员函数名应是动词。
   5.3 .类的存取和查询成员函数名应该是名词或形容词。

…