C_命名规范.doc

.NET开发编程规范第1章程序的版式版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。,包含内容如下:1、版权信息2、摘要3、当前版本4、作者5、修改作者6、完成日期7、版本历史信息例:///<copyright>Copyright(c)2006,有限公司</copyright>///<copyright>Allrightsreserved.</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#中代码注释这样写的好处是VisualStuidio能够在编译的时候自动生成xml格式的注释文档。。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。在每个类声明之后、每个函数定义结束之后都要加空行。参见示例1-2(a)在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔。参见示例1-2(b)//空行voidFunction1(…){…}//空行voidFunction2(…){//空行while(condition){statement1;//空行if(condition){statement2;…}//空行voidFunction3(…){…}}else{statement3;}//空行statement4;}示例1-2(a)函数之间的空行示例1-2(b)(1)一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。(2)if、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。示例1-3(a)为风格良好的代码行,示例1-3(b)为风格不良的代码行。intwidth;//宽度intheight;//高度intdepth;//深度intwidth,height,depth;//宽度高度深度x=a+b;y=c+d;X=a+b;y=c+d;z=e+f;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)风格不良的代码行【建议】尽可能在定义变量的同时初始化该变量(就近原则)如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用了未被初始化的变量,可能会导致程序错误。本建议可以减少隐患。例如intwidth=10;//定义并初绐化widthintheight=10;//定义并初绐化heightintdepth=10;//(1)关键字之后要留空格。象const、case等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。(2)函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。(3)‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。(4)‘,’之后要留空格,如Function(x,y,z)。如果‘;’不是一行的结束符号,其后要留空格,如for(initialization;condition;update)。(5)赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的