注释规范 |
1.自己创建的代码问价在文件前写注释(可以使用自动生成注释)注释的形式一般包括
/*************************************************
作者:
小组:
说明:
创建日期:
版本号:
**********************************************/
2.如果模块值进行部分少量代码的修改,每次添加需要添加注释
///修改人:
///修改日期:<YYYY-MM-DD>
///备份:
/*原代码内容*
3.对于重构类的文件需要对原来的类文件做备份,然后放在统计目录下并且添加后缀
4.代码的注释又分为多行注释和单行注释
单行注释:
//<单行注释>
多行注释:
/*多行注释1
多行注释2
多行注释3*/
命名规范 |
Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写
(1)在类属性的名称中包含类名是多余的,如Book.BookTitle。而是应该使用Book.Title。
(2)在变量名中使用互补对,如min/max、begin/end和open/close。
(3)布尔变量名应该包含Is,这意味着Yes/No或True/False值,如fileIsFound。
(4)即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如i或j。
(5)文件名要和类名相同,一般情况下一个类一个文件,文件名遵从Pascal命名法,无特殊情况,扩展名小写,使用统一而又通用的文件扩展名:C#类.cs。
(6)不要将缩写或缩略形式用作标识符名称的组成部分。
(7)类名使用Pascal大小写,使用全称避免缩写,除非缩写已是一种公认的约定,如URL、HTML。
(8)接口使用Pascal大小写。在原有类名基础上加“I”,如:IUserDao
(9)参数参数名称使用Camel大小写
(10)方法使用Pascal大小写。,禁止缩写
版本管理规则 |