C++编程规范

最新推荐文章于 2024-09-01 21:55:24 发布

小小破橘儿

最新推荐文章于 2024-09-01 21:55:24 发布

阅读量516

点赞数 21

分类专栏： C++学习文章标签： c++ 笔记

本文链接：https://blog.csdn.net/m0_57692057/article/details/140906142

版权

C++学习专栏收录该内容

1 篇文章 0 订阅

订阅专栏

声明：林锐博士的《高质量C++/C编程指南》阅读笔记

一、文件结构

头文件：放声明；

源文件：放实现；

1.1 版权和版本的声明

位置：头文件/源文件的开头

内容：

(1)版权信息。

(2文件名称，标识符，摘要。

(3)当前版本号，作者/修改者，完成日期。

(4)版本历史信息。

1.2 头文件结构

头文件由三部分内容组成:

头文件开头处的版权和版本声明。
预处理块。
函数和类结构声明等。

规则：

为了防止头文件被重复引用，应当用ifndef/define/endif 结构产生预处理块。

用#include <filename.h>格式来引用标准库的头文件（编译器将从标准库目录开始搜索)。

用#include“filename.h”格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索)。

建议：

头文件中只存放“声明”而不存放“定义”；

不提倡使用全局变量,尽量不要在头文件中出现象extern int value这类声明.

1.3 源文件的结构

内容:

(1)开头处的版权和版本声明。

(2)对一些头文件的引用。

(3)程序的实现体(包括数据和代码)。

二、程序版式

2.1 空行

类声明之后、函数定义结束之后都要加空行。

函数体内，逻揖上密切相关（if、else if、else）的语句之间不加空行，其它地方应加空行分隔。

2.2 代码行

一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。

if、for、while、do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

建议：尽可能在定义变量的同时初始化该变量

2.3 代码行内的空格

关键字之后要留空格。像 const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨析关键字。像If、For、While等关键字之后应留一个空格再跟左括号‘(’，以突出关键字。

函数名之后不要留空格，紧跟左括号‘(’，以与关键字区别。

‘(’向后紧跟，‘)'、‘，'、;’向前紧跟，紧跟处不留空格。

‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for ( initialization ; cond i tion ; update)。

赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”，“^”等二元操作符的前后应当加空格。

一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符）等前后不加空格。

像“[]”、“.”、“->”这类操作符前后不加空格。

建议：较长的for语句与if语句，为了紧凑可以适当的去除一些空格。

2.4 对齐

程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。

{}之内的代码块在‘{’右边数格处左对齐。

2.5 长行拆分

代码行最大长度宜控制在70至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。

长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

2.6 修饰符的位置

应当将修饰符*和&紧靠变量名

2.7 注释

注释是对代码的“提示”，不宜过多过花哨。

如果代码本来就是清楚的，则不必加注释。

边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。

尽量避免在注释中使用缩写，特别是不常用缩写。

注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。

当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

2.8 类的版式

建议：

以行为为中心：public类型的函数写在前，private类型的数据写在后面；

三、命名规则

C++标识符构成规则：

以字母或下划线“_”开始；

由字母、数字、下划线组成；

字母大小写代表不同的标识符；

不能是C++关键字；

3.1 共性规则

标识符应当直观且可以拼读，可望文知意最好采用英文单词或其组合，便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂，用词应当准确。

标识符的长度应当符合“min-length && max- information”原则。―般来说，长名字能更好地表达含义，所以函数名、变量名、类名长达十几个字符不足为怪。那么名字是否越长越好?不见得!例如变量名maxval就比 maxValueUntil Overflow好用。单字符的名字也是有用的，常见的如 i , j , k,m , n ,x,y ,z等，它们通常可用作函数内的局部变量。

命名规则尽量与所采用的操作系统或开发工具的风格保持一致。例如Windows应用程序的标识符通常采用“大小写”混排的方式，如 AddChild。而Unix应用程序的标识符通常采用“小写加下划线”的方式，如 add_child。别把这两种风格混合使用。

程序中不要出现仅靠大小写区分的相似的标识符。例如:Int ×，X;变量×与×容易混淆

程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解。

变量的名字应当使用“名词”或者“形容词＋名词”。例如:

float value;

float oldValue;

float newValue;

全局函数的名字应当使用“动词”或者“动词＋名词”(动宾词组)。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。

例如:

DrawBox();//全局函数

box->Draw();l/类的成员函数

用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如:

int minValue;

int maxValue;

int SetValue(..);

int GetValue(..)；

建议：

尽量避免名字中出现数字编号，如 Val ue1,Val ue2等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事)。

3.2 简单的Windows应用程序命名规则

类名和函数名用大写字母开头的单词组合而成。

变量和参数用小写字母开头的单词组合而成。

常量全用大写的字母，用下划线分割单词。

静态变量加前缀s_（表示 static)。

如果不得已需要全局变量，则使全局变量加前缀g_（表示 global)。

类的数据成员加前缀m_(表示 member)，这样可以避免数据成员与成员函数的参数同名。

为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头，所有常量（或宏定义）均以GL开头。

3.3 简单的Unix应用程序命名规则

电子书上没得，这部分内容来源于网络，有错误的地方欢迎指正。

        1.使用小写字母和下划线.
        在Unix-Like风格中，通常使用小写字母和下划线来命名文件和目录。这样的命名风格更易于阅读和书写，并且避免了大小写带来的问题。例如，可以使用" file_ name"而不是" FileName"。
        2、避免特殊字符: 应用程序的名称应尽量避免使用特殊字符，尤其是那些在Unix系统中具有特殊含义的字符，如空格、斜杠 /、星号 * 等。这样可以避免在命令行输入时的歧义和误解。

3、连字符分隔: 应用程序的名称通常使用连字符”_”分隔单词，而不是使用空格或者驼峰命名法（CamelCase）。例如，grep、ls、chmod 等。

4、简洁明了: 应用程序的名称应该简洁明了，能够准确地描述其功能或者用途。这有助于用户快速理解和记忆程序的作用。

5、无扩展名: Unix系统中的可执行文件通常没有扩展名，例如上述的 grep、ls 等。这与Windows系统的可执行文件命名习惯不同。

约定俗成的命名: 在Unix系统中，有些应用程序的命名已经形成了一定的约定俗成：

以 d 开头的通常表示守护进程（daemon），如 cron、httpd。

以 sys 结尾的通常表示系统相关的工具或库，如 sysctl。

以 conf 结尾的通常表示配置文件，如 nginx.conf。