返回列表 回复 发帖

任何书写高质量的perl表达式

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

    可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。

    1,空行

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

【规则1-1】在每个类声明之后、每个函数定义结束之后都要加空行。

【规则1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。

    2,代码行

【规则2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。

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

【建议2-1】尽可能在定义变量的同时初始化该变量(就近原则)

    3, 代码行内的空格

【规则3-1】关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。

【规则3-2】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。

【规则3-3】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。

【规则3-4】‘,’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如for (initialization; condition; update)。

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

【规则3-6】一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格。

【规则3-7】象“[]”、“.”、“->”这类操作符前后不加空格。

【建议3-1】对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格,如for (i=0; i<10; i++)和if ((a<=b) && (c<=d))
  1. void Func1(int x, int y, int z);          // 良好的风格
  2. void Func1 (int x,int y,int z);           // 不良的风格
  3. if (year >= 2000)                         // 良好的风格
  4. if(year>=2000)                            // 不良的风格
  5. if ((a>=b) && (c<=d))                     // 良好的风格
  6. if(a>=b&&c<=d)                            // 不良的风格
  7. for (i=0; i<10; i++)                      // 良好的风格
  8. for(i=0;i<10;i++)                         // 不良的风格
  9. for (i = 0; I < 10; i ++)                 // 过多的空格
  10. x = a < b ? a : b;                        // 良好的风格
  11. x=a<b?a:b;                                // 不好的风格
  12. int *x = &y;                              // 良好的风格  
  13. int * x = & y;                            // 不良的风格  
  14. array[5] = 0;                             // 不要写成 array [ 5 ] = 0;
  15. a.Function();                             // 不要写成 a . Function();
  16. b->Function();                            // 不要写成 b -> Function();
复制代码
4,对齐

【规则4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。

【规则4-2】{ }之内的代码块在‘{’右边数格处左对齐。

    5,长行拆分

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

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

    6,修饰符的位置

【规则6-1】应当将修饰符 * 和 & 紧靠变量名

    7,注释

【规则7-1】注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少。

【规则7-2】如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如 i++;     // i 加 1,多余的注释

【规则7-3】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。

【规则7-4】注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。

【规则7-5】尽量避免在注释中使用缩写,特别是不常用缩写。

【规则7-6】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。

【规则7-8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

                     我是一个呼吸着现在的空气而生活在过去的人
               这样的注定孤独,孤独的身处闹市却犹如置身于荒漠
                                     我已习惯了孤独,爱上孤独
                                 他让我看清了自我,还原了自我
                             让我再静静的沉思中得到快乐和满足
                                   再孤独的世界里我一遍又一遍
                                   不厌其烦的改写着自己的过去
                                             延伸到现在与未来
                                       然而那只是泡沫般的美梦
                                 产生的时刻又伴随着破灭的到来
                         在灰飞烟灭的瞬间我看到的是过程的美丽
                                      而不是结果的悲哀。。。
返回列表