程序的编写风格

水深无声 2022-08-09 05:10 162阅读 0赞

编程风格虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。

## 1. 空行 ##

空行起着分隔程序段落的作用。空行得体（不能过多也不能过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。

¯        在每个类声明之后、每个函数定义结束之后都要加空行。例如：

<table> 
 <tbody> 
 <tr> 
 <td> //类定义之后要用空格 class Date{ public: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Date(int x, int y, int z); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ~Date(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; void Show(); private: &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int year; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int month; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int day; }; //空行 class Time{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ...... &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </td> 
 <td> Date::Date(int x, int y, int z) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; year = x; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; month = y; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; day = z; } //空行 Date::~Date() { } //空行 void Date::Show() { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; cout&lt;&lt;year&lt;&lt;"-"&lt;&lt;month&lt;&lt;"-"&lt;&lt;day&lt;&lt;endl; } </td> 
 </tr> 
 </tbody> 
</table>

## 2. 代码行 ##

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

¯        if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加\{\}（建议最好这样，不要怕麻烦）。这样可以防止书写失误。

¯        尽可能在定义变量的同时初始化该变量（就近原则）

如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如

int width = 10;     // 定义并初绐化width

char \*name = new char\[10\]; //直接申请空间，而不至于出现未给指针变量指向空间的错误

## 3. 代码行内的空格 ##

¯        关键字之后要留空格。像const、virtual、inline、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像if、for、while等关键字之后可以留一个空格再跟左括号‘（’，以突出关键字。

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

¯        ‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。

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

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

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

¯        像“［］”、“.”、“->”这类操作符前后不加空格。

¯        对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i<10; i++)和if ((a<=b) && (c<=d))

例如：

<table> 
 <tbody> 
 <tr> 
 <td> void Func1(int x, int y, int z);&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 良好的风格 void Func1 (int x,int y,int z);&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 不良的风格 </td> 
 </tr> 
 <tr> 
 <td> if (year &gt;= 2000)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 良好的风格 if(year&gt;=2000)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 不良的风格 if ((a&gt;=b) &amp;&amp; (c&lt;=d))&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 良好的风格 if(a&gt;=b&amp;&amp;c&lt;=d)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 不良的风格 </td> 
 </tr> 
 <tr> 
 <td> for (i=0; i&lt;10; i++)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 良好的风格 for(i=0;i&lt;10;i++)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 不良的风格 for (i = 0; I &lt; 10; i ++)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 过多的空格 </td> 
 </tr> 
 <tr> 
 <td> x = a &lt; b ? a : b;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 良好的风格 x=a&lt;b?a:b;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 不好的风格 </td> 
 </tr> 
 <tr> 
 <td> int *x = &amp;y;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 良好的风格&nbsp; int * x = &amp; y;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 不良的风格&nbsp; </td> 
 </tr> 
 <tr> 
 <td> array[5] = 0; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 不要写成 array [ 5 ] = 0; a.Function();&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 不要写成 a . Function(); b-&gt;Function();&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 不要写成 b -&gt; Function(); </td> 
 </tr> 
 </tbody> 
</table>

## 4. 对齐 ##

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

¯        \{ \}之内的代码块在‘\{’右边数格处左对齐。（建议采用VC++6.0建议的默认风格）

## 5. 长行拆分 ##

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

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

<table> 
 <tbody> 
 <tr> 
 <td> if ((very_longer_variable1 &gt;= very_longer_variable12) &amp;&amp; (very_longer_variable3 &lt;= very_longer_variable14) &amp;&amp; (very_longer_variable5 &lt;= very_longer_variable16)) { &nbsp;&nbsp;&nbsp; dosomething(); } </td> 
 </tr> 
 <tr> 
 <td> virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CMatrix rightMatrix); &nbsp; </td> 
 </tr> 
 <tr> 
 <td> for (very_longer_initialization; &nbsp;&nbsp;&nbsp; &nbsp;very_longer_condition; &nbsp;&nbsp;&nbsp; &nbsp;very_longer_update) { &nbsp;&nbsp;&nbsp; dosomething(); } </td> 
 </tr> 
 </tbody> 
</table>

## 6. 修饰符的位置 ##

¯        应当将修饰符 \* 和 ＆ 紧靠变量名

例如：

char  \*name;

int   \*x, y;    // 此处y不会被误解为指针

## 7. 注释 ##

C语言的注释符为“/\*…\*/”。C++语言中，程序块的注释常采用“/\*…\*/”，行注释一般采用“//…”。注释通常用于：

（2）函数接口说明；

（3）重要的代码行或段落提示。

虽然注释有助于理解代码，但注意不可过多地使用注释。

¯        注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。

¯        如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。例如

i++;    // i 加 1，多余的注释

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

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

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

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

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

## 8. 类的版式 ##

类可以将数据和函数封装在一起，其中函数表示了类的行为（或称服务）。类提供关键字public、protected和private，分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的，即让类仅仅公开必须要让外界知道的内容，而隐藏其它一切内容。我们不可以滥用类的封装功能，不要把它当成火锅，什么东西都往里扔。

在定义类的时候，究竟是以定义数据成员开始还是以定义成员函数开始要看编程者的习惯。以下是两种方式：

<table> 
 <tbody> 
 <tr> 
 <td> class A { &nbsp; private: int&nbsp;&nbsp;&nbsp; i, j; float&nbsp; x, y; &nbsp;&nbsp;&nbsp; … &nbsp; public: void Func1(void); void Func2(void); … } </td> 
 <td> class A { &nbsp; public: void Func1(void); void Func2(void); … &nbsp; private: int&nbsp;&nbsp;&nbsp; i, j; float&nbsp; x, y; &nbsp;&nbsp;&nbsp; … } </td> 
 </tr> 
 </tbody> 
</table>

(摘自《高质量C++编程指南》)