节选自阿里云社区https://developer.aliyun.com/article/193763
正文如下:
代码编写规范
一、排版
1.包含头文件
1.1 先系统头文件,后用户头文件
1.2 只引用需要的头文件
2.h和cpp文件
2.1 头文件命名为.h,内联文件命名为.inl;C++文件命名为*.cpp
2.2 文件名用大小写混合,或者小写混合。例如DiyMainview.cpp,infoview.cpp。不要用无意义的名称:例如XImage.cpp;SView.cpp;xlog.cpp;
二、注释
1.文件头注释
1.1 作者,文件名称,文件说明,生成日期(可选)
2.函数注释
2.1 关键函数必须写上注释,说明函数的用途。
2.2 特别函数参数,需要说明参数的目的,由谁负责释放等等。
2.3 除了特别情况,注释写在代码之前,不要放到代码行之后。
2.4 对每个#else或#endif给出行末注释。
2.5 关键代码注释,包括但不限于:赋值,函数调用,表达式,分支等等。
2.6 善未实现完整的代码,或者需要进一步优化的代码,应加上 // TODO ...
2.7 调试的代码,加上注释 // only for DEBUG
2.8 需要引起关注的代码,加上注释 // NOTE ...
2.9 对于较大的代码块结尾,如for,while,do等,可加上 // end for|while|do
三、命名方面
1.1.原则
1.1 同一性:在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格,保持命名风格在整个模块中的同一性。
1.2 标识符组成:标识符采用英文单词或其组合,应当直观且可以拼读,可望文知意,用词应当准确,避免用拼音命名。
1.3 最小化长度 && 最大化信息量原则:在保持一个标识符意思明确的同时,应当尽量缩短其长度。
1.4 避免过于相似:不要出现仅靠大小写区分的相似的标识符,例如"i"与"I","function"与"Function"等等。
1.5 避免在不同级别的作用域中重名:程序中不要出现名字完全相同的局部变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但容易使人误解。
1.6 正确命名具有互斥意义的标识符:用正确的反义词组命名具有互斥意义的标识符,如:"nMinValue" 和 "nMaxValue","GetName()" 和"SetName()" ….
1.7 避免名字中出现数字编号:尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。
标签:头文件,标识符,代码,注释,命名,cpp,大二,做到 From: https://www.cnblogs.com/Lin-4126/p/18396817