程序设计语言的代码风格.ppt

关于代码风格问题 王　腾 towangteng@263.net 目　录 程序版式 程序版式不影响程序的功能，但影响程序的可读性 追求 清晰、整洁、美观、一目了然 容易阅读，容易测试 不良的风格 良好的风格 对齐（Alignment）与缩进（indent） 保证代码整洁、层次清晰的主要手段。 “{”的位置 {和}独占一行，且位于同一列，与引用它们的语句左对齐，便于检查配对情况 位于同一层{和}之内的代码在{右边数格处左对齐，即同层次的代码在同层次的缩进层上 一般用设置为4个空格的Tab键缩进，不建议使用空格缩进 代码行内的空格——增强单行清晰度 关键字之后加空格 函数名之后不加空格 赋值、算术、关系、逻辑等二元运算符前后各加一空格，但一元运算符前后一般不加空格 sum = sum + term; “(”向后紧跟，“) , ;”向前紧跟，紧跟处不留空格 , ;后留一个空格 Function(x, y, z)、 for (initialization; condition; update) [] . - 前后不加空格 对表达式较长的for和if语句，为了紧凑可适当去掉一些空格 for (i=0; i10; i++) if ((a+bc) (b+ca) (c+ab)) 代码行 一行只写一条语句，这样方便测试 一行只写一个变量，这样方便写注释 int width; //宽度 int height; //高度 int depth; //深度 尽可能在定义变量的同时，初始化该变量 int sum = 0; if、for、while、do等语句各占一行，执行语句无论有几条都用{和}将其包含在内，这样便于维护 if (width height) { DoSomething(); } 注释的重要性 注释对于程序犹如眼睛对于人的重要性一样 没有注释的程序对于读者好比眼前一团漆黑，跟拿到一个可执行程序别无二致 不规范的注释和好几千度的近似眼没什么区别 代码本身体现不出价值 开发程序的思维才能使其变得有价值 这种思维的具体体现就是在于注释和规范的代码本身 在哪些地方写注释？ 在重要的文件首部 文件名 + 功能说明 + [作者] + [版本] + [版权声明] + [日期] 在用户自定义函数前 对函数接口进行说明 函数功能 + 入口参数 +出口参数 + 返回值 （包括出错处理） 在一些重要的语句块上方 对代码的功能、原理进行解释说明 在一些重要的语句行右方 定义一些非通用的变量 函数调用 较长的、多重嵌套的语句块结束处 在修改的代码行旁边加注释 例：文件开头的注释 /* 程序名称：简易绘画器 功能：具有图像重画的功能，使用红色、绿色、蓝色三种颜 色绘制长方形、圆角矩形、直线和椭圆四种形状 程序设计者：LiMing 版本：1.0 创建时间：2010/11/12 */ 例：函数的注释 /* 函数名称：max(int x, int y, int z) 函数功能：求三数之中的最大值。 输入参数：x, y, z表示将要比较的三个整数 返回值： 返回值为三数之中的最大值，类型为整型 */ Slide * * 程序版式 1 程序注释 2 # include iostream using namespace std; int main () {int i=1,sum=0; while ( i=100 ) {sum=sum+i ; i ++ ;} cout sum = sum endl ; return 0;} # include iostream using namespace std; int main () { int i = 1 ； sum = 0 ; while ( i = 100 ) { sum = sum + i ; i ++ ; } cout sum = sum endl ; return 0; } 如果出现嵌套的｛｝，则使用缩进对齐，如： { … { … } … } while (condition){ … // program code } while (condition) { … // program code } for (initialization; condition; update){ … // program code } for (initialization; conditio