——黑马程序员—— 编程时代码这样写才漂亮

-----------android培训、java培训、java学习型技术博客、期待与您交流！------------

第二篇——编程时代码的书写

    编程时代码的书写版式虽然不会影响程序的功能，但会影响可读性和美观性。程序的版式追求清晰、美观，是程序风格的重要构成因素。代码的版式就像是我们中文的书法，好的代码可让人对程序一目了然看得兴致勃勃。而差的代码一团乱糟糟的，让人看得索然无味，更是令维护者烦恼至极。因此个人觉得写好代码的版式是很有必要的。

规则一：代码行

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

（2）if、for、while、do 等语句最好自占一行，执行语句最好不要紧跟其后。即使执行语句有一行是也都要加{}。这样可以防止书写失误。

示例 a：形式优美可读性强的代码

int width;  // 宽度 
int height; // 高度 
int depth;  // 深度  
  
x = a + b; 
y = c + d; 
z = e + f; 
 
if (width < height)  
{ 

dosomething();
 
} 

for (initialization; condition; update) 

{
 
dosomething();
 
} 

other();  

        示例 b：形式杂乱可读性不强代码

int width, height, depth; // 宽度高度深度  
 
X ＝ a + b;   y = c + d;  z = e + f;  
if (width < height)  { dosomething(); } 
if (width < height) dosomething(); 
for (initialization; condition; update) { dosomething(); } 
// 空行 
other();  

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

规则二：空行

       空行起着分隔程序段落的作用。空行得体（不过多 也不过少）将会使程序的布局更加清晰。空行不会浪费内存，所以不要舍不得用空行。

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

（1）在每个类声明之后、每个函数定义结束之后都要加空行。
（2）在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。

示例 a：函数之间的空行

// 空行
void Function1(⋯)
{
     ⋯
}
// 空行
void Function2(⋯)
{
     ⋯
}
// 空行
void Function3(⋯)
{
     ⋯
}
// 空行
while (condition)
{
     statement1;
// 空行
if (condition)
{
     statement2;
}
else
{
     statement3;
}

示例 b：函数内部之间的空行

// 空行
while (condition)
{
     statement1;
// 空行
if (condition)
{
     statement2;
}
else
{
     statement3;
}
// 空行
     statement4;
}

规则三：代码内的空行

（1）关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格，否则无法辨析关键字。象if、for、while 等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。
（2）函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。
（3）‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。
（4）‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。
（5）赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“ ||”、“<<”,“^”等二元操作符的前后应当加空格。
（6）一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格。
（7）像“［］”、“.”、“->”这类操作符前后不加空格。

示例代码：

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

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

规则四：对齐

（1）程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐。
（2）{ }之内的代码块在‘{’右边数格处左对齐。

规则五：长行拆分

（1）代码行最大长度宜控制在70 至80 个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。
（2）长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

示例代码：

if ((very_longer_variable1 >= very_longer_variable12)

&& (very_longer_variable3 <= very_longer_variable14)

&& (very_longer_variable5 <= very_longer_variable16))

{

dosomething();

}

virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix,

CMatrix rightMatrix);

for (very_longer_initialization;

very_longer_condition;

very_longer_update)

{

dosomething();

}

规则六：修饰符的位置

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

例如：

char *name;

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

规则七：注释

（1）虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例 2-6。
（2）注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。
（3）如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。例如i++; // i 加 1，多余的注释
（4）边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
（5）注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。
（6）尽量避免在注释中使用缩写，特别是不常用缩写。
（7）注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。
（8）当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

以上就是对代码书写的总结 希望有用 ！！！