软件开发代码规范
- 格式:doc
- 大小:98.00 KB
- 文档页数:12
软件开发代码规范(C#版)
拟制:日期:2007-2-13审核:日期:
审核:日期:
批准:日期:
版权所有 ********有限公司
修订纪录
目录
1、第一章命名规范...................................... 错误!未定义书签。、第一节总则............................................. 错误!未定义书签。、第二节变量命名规范...................................... 错误!未定义书签。
、CodeBehind内部命名规范............................ 错误!未定义书签。
、控件命名规范....................................... 错误!未定义书签。、第三节常量命名规范..................................... 错误!未定义书签。、第四节命名空间、类、方法命名规范....................... 错误!未定义书签。、第五节接口命名规范..................................... 错误!未定义书签。、第六节命名规范小结................................. 错误!未定义书签。
2、第二章代码注释规范....................................... 错误!未定义书签。、第一节模块级注释规范(命名空间、类等)................. 错误!未定义书签。、第二节方法级注释规范................................... 错误!未定义书签。
、属性注释.......................................... 错误!未定义书签。
、方法注释.......................................... 错误!未定义书签。、第三节代码间注释规范................................... 错误!未定义书签。
3、第三章编写规范.......................................... 错误!未定义书签。、第一节格式规范.......................................... 错误!未定义书签。、第二节编程规范.......................................... 错误!未定义书签。
、程序结构要求...................................... 错误!未定义书签。
、可读性要求........................................ 错误!未定义书签。
、结构化要求........................................ 错误!未定义书签。
、正确性与容错性要求................................ 错误!未定义书签。
、可重用性要求...................................... 错误!未定义书签。
、interface使用注意事项............................ 错误!未定义书签。
、类使用注意事项.................................... 错误!未定义书签。
、流程控制语句注意事项.............................. 错误!未定义书签。
、其他应注意事项.................................... 错误!未定义书签。
注:Pascal命名法则:即名称中所有单词的第一个字母大写其他字母使用小写形式。
Camel命名法则:即名称中第一个单词各个字母全部小写,其他部分遵循Pascal命名法则。
1、第一章命名规范
1.1、第一节总则
1.本命名规则除特殊提及外统一使用Camel命名法则。
如:controlMenu
2.命名时尽量不使用拼音,更不可使用拼音缩写(专有名词除外)。
3.如果使用品牌名称命名时其大小写尽量保持和品牌名称一致的样式。
如:LuX则命名时,不要写成LUX,或者Lux,而应该保持与原品牌名称风格一致使用LuX
4.使用专有名词或英文缩写命名时采用大写形式。
如:CNNIC
5.禁止使用仅区分大小写的方式命名。
如:Abc与abc仅用大写A来区分,这样写在类C系语言中不会出错,但是不利于系统的迁移
、第二节变量命名规范
1.2.1、CodeBehind内部命名规范
1.公有字段/属性使用Pascal 命名规则,私有变量/保护变量/局部变量使用Camel命名规则,遵循动宾结构。
例:
public class Hello
{
private string userName;
private DateTime loginTime;
private bool isOnline;
public string UserName {
get { return ; }
}
}
2.即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用意义描述性的名称。仅对于短循环索引使用单字母变量名,如 i 或 j
3.在变量名中使用互补对,如 Min/Max、Begin/End 和 Open/Close。
4.当一个方法内部变量繁多的时候,可以使用Camel命名法则,其中第一个单词可以使用变量类型的缩写来说明以示区别。
例: