欢迎来到天天文库
浏览记录
ID：19713866
大小：31.50 KB
页数：12页
时间：2018-10-05
《基于net项目代码书写规范要求书》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。
1、基于NET项目的代码书写规范要求书基于.NET项目的代码书写规范要求书本文为下半年为一项目撰写的简要代码书写规范，不尽详尽，但仍有参考价值。但是代码书写规范更重要的是项目组内组员的意识性的提高，根据此项目到目前为止的状况，就此简单规范的实现情况并不乐观，代码中仍有五花八门各个流派的风格，此问题系软件项目组管理中的不完善所致，在此并不研究此问题。第一章主体命名规范一、外挂服务命名规范1)服务项目命名所有服务项目名使用ESrv（注意大小写）开头，第五位字母开始自订义，但是第五位字母必须大写。比如ESrvDemo1，其中Demo1为自定义名称
2、。二、类成员访问权限规范所有类成员要严格的按照成员的使用性质，设置它们的访问修饰符，修饰符的意义如下：声明的可访问性意义public访问不受限制。protected访问仅限于包含类或从包含类派生的类型。internal访问仅限于当前程序集。protectedinternal访问仅限于从包含类派生的当前程序集或类型。private访问仅限于包含类型。第二章代码书写规范一、代码注释规范1).cs文件的注释所有.cs文件开头都要加上注释，写明文件创建时间、作者、用途概述等格式如下://*****************************
3、***************************//新增日期:2004.7.19//作者:XXX//?热菟得?: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX//********************************************************2)函数过程注释所有的函数体开头都要加上注释，所以注释使用.NET注释规范，如下格式：//////构造函数//////示例参数1///4、mname="is_xxx2">示例参数2publicUpgradeThread(stringis_xxx1,stringis_xxx2){//...}3)常量变量注释所有的常量变量，无论是全局还是局部使用的，凡是对代码整体起到关键性做用的都需要加上注释。如下示例：//////当前线程指向的备份文件本地保存路径///publicstringStorePath="";4)代码修改注释当开发者维护以前的程序代码时，需要在修改处的开始及结尾，加上自己的注释信息，格式如下://BEGIN205、04-7-19Jayson 修正了XXX问题略...//END2004-7-19Jayson二、代码排版规范1)语句结构为保证语句结构的清晰和程序的可读性，在编写软件程序时应注意以下几个方面的问题：l在一行内只写一条语句，并采用空格、空行和移行保证清楚的视觉效果。l每一个嵌套的函数块，使用一个TAB缩进，大括号必须放在条件语句的下一行，单独成一行，便于匹对。如，有一段程序如下：for(inti=0;i<10;i++){Console.WriteLine("xxxxx")}应该写为:for(inti=0;i<10;i++){Console6、.WriteLine("xxxxx")}2)代码书写格式规范l文件之中不得存在无规则的空行，比如说连续十个空行。一般来讲函数与函数之间的空行为2-3行；l在函数体内部，在逻辑上独立的两个函数块可适当空行，一般为1-2行。l每行长度尽量避免超过屏幕宽度，应不超过80个字符。l尽量用公共过程或子程序去代替重复的功能代码段。l使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。如将x=a*b/c*d写成x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d)。l避免采用过于复杂的条件测试。l避免过多的循环嵌套和条件嵌套。l一个函数不7、要超过200行。一个文件应避免超过2000行。l避免使用goto语句。l避免采用多赋值语句，如x=y=z;三、结构定义规范1)命名规则（定义在iTradeDefine命名空间里面)：l用大写字母表示lTAG_XXXX以TAG大头，下划线后面定义具体结构的名称2)示例：lpublicstructTAG_ALLMESSAGE四、枚举类型定义规范1)命名规则:l用大写字母表示lEU_XXXX以EU打头，下划线后面定义类型名称2)示例:lpublicenumEU_MESSAGE五、常量定义规范1)全局使用常量(定义在iTradeDefine命名8、空间里面)l示例：npublicconstboolG_TRANS_FALSE=false;l常量定义规范n大写字母命名nG_XXX_YYYG表示全局，XXX标识常量用途，YYY标识具体的值2)局部使用常量（
4、mname="is_xxx2">示例参数2publicUpgradeThread(stringis_xxx1,stringis_xxx2){//...}3)常量变量注释所有的常量变量，无论是全局还是局部使用的，凡是对代码整体起到关键性做用的都需要加上注释。如下示例：//////当前线程指向的备份文件本地保存路径///publicstringStorePath="";4)代码修改注释当开发者维护以前的程序代码时，需要在修改处的开始及结尾，加上自己的注释信息，格式如下://BEGIN20
5、04-7-19Jayson 修正了XXX问题略...//END2004-7-19Jayson二、代码排版规范1)语句结构为保证语句结构的清晰和程序的可读性，在编写软件程序时应注意以下几个方面的问题：l在一行内只写一条语句，并采用空格、空行和移行保证清楚的视觉效果。l每一个嵌套的函数块，使用一个TAB缩进，大括号必须放在条件语句的下一行，单独成一行，便于匹对。如，有一段程序如下：for(inti=0;i<10;i++){Console.WriteLine("xxxxx")}应该写为:for(inti=0;i<10;i++){Console
6、.WriteLine("xxxxx")}2)代码书写格式规范l文件之中不得存在无规则的空行，比如说连续十个空行。一般来讲函数与函数之间的空行为2-3行；l在函数体内部，在逻辑上独立的两个函数块可适当空行，一般为1-2行。l每行长度尽量避免超过屏幕宽度，应不超过80个字符。l尽量用公共过程或子程序去代替重复的功能代码段。l使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。如将x=a*b/c*d写成x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d)。l避免采用过于复杂的条件测试。l避免过多的循环嵌套和条件嵌套。l一个函数不
7、要超过200行。一个文件应避免超过2000行。l避免使用goto语句。l避免采用多赋值语句，如x=y=z;三、结构定义规范1)命名规则（定义在iTradeDefine命名空间里面)：l用大写字母表示lTAG_XXXX以TAG大头，下划线后面定义具体结构的名称2)示例：lpublicstructTAG_ALLMESSAGE四、枚举类型定义规范1)命名规则:l用大写字母表示lEU_XXXX以EU打头，下划线后面定义类型名称2)示例:lpublicenumEU_MESSAGE五、常量定义规范1)全局使用常量(定义在iTradeDefine命名
8、空间里面)l示例：npublicconstboolG_TRANS_FALSE=false;l常量定义规范n大写字母命名nG_XXX_YYYG表示全局，XXX标识常量用途，YYY标识具体的值2)局部使用常量（
此文档下载收益归作者所有
