C_命名规范.docVIP

.NET开发编程规范 第1章 程序的版式 版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。 ? 可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。 ? 1.1 版本和版权的声明写在文件的开头，包含内容如下： 1、 版权信息 2、 摘要 3、 当前版本 4、 作者 5、 修改作者 6、 完成日期 7、 版本历史信息 例： ///copyright Copyright (c) 2006,有限公司/copyright ///copyright All rights reserved./copyright ///abstract描述文件的内容，实现的功能和算法等内容/abstract ///current_version当前版本/current_version ///author作者/author ///finish_date完成日期/finish_date ///replace_version取代版本/replace_version ///modify修改/modify ///modify_author修改作者/modify_author ///modify_date修改日期/modify_date 版本版权声明示例 在C#中代码注释这样写的好处是Visual Stuidio能够在编译的时候自动生成xml格式的注释文档。 ? 1.2 空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。 ? 在每个类声明之后、每个函数定义结束之后都要加空行。参见示例1-2（a）在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例1-2（b ） ? // 空行 void Function1(…) { ?… } // 空行 void Function2(…) { ?… } // 空行 void Function3(…) { ?… } ? // 空行 while (condition) { ??? statement1; ??? // 空行 ??? if (condition) ??? { ??????? statement2; ??? } ??? else ??? { ??????? statement3; ??? } // 空行 ??? statement4; }? 示例1-2(a) 函数之间的空行??????????????????示例1-2(b) 函数内部的空行 1.3 (1)一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 ? (2)if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。 ? 示例1-3（a）为风格良好的代码行，示例1-3（b）为风格不良的代码行。 ? ? int width;?// 宽度 int height; // 高度 int depth;?// 深度 ? int width, height, depth; ?// 宽度高度深度 ? x = a + b; y = c + d; z = e + f; X ＝ a + b;?? y = c + d;?z = e + f; ? if (width height) { dosomething(); } if (width height) dosomething(); for (initialization; condition; update) { dosomething(); } // 空行 other(); ? for (initialization; condition; update) ???? dosomething(); other(); ? ? 示例1-3(a) 风格良好的代码行????????????????示例1-3(b) 风格不良的代码行 ? 【建议】尽可能在定义变量的同时初始化该变量（就近原则） ? 如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如 ? int width = 10; ??? // 定义并初绐化width int height = 10;??? // 定义并初绐化height int depth = 10; ??? // 定义并初绐化depth ? 1.4 (1)关键字之后要留空格。象const、case 等关键字之后至少要留一个