.Net 开发部分代码规范

Keywords:

1.       程序中具有物理含义的变量须尽量贴近物理公式中变量的表示方法,本软件物理参数*必须*优先使用下表中的表示方法.

2.       类和命名空间使用名词词组,并大驼峰方式命名,首字母必须大写,不要使用下划线字符 ( _ )

3.       方法名称首字母大写, 必须写明其执行的功能注释.推荐使用<summary>注释

4.       功能极度近似的代码不能连续重复超过两次,考虑使用函数方法的方式重复执行.

5.       被继承的基类以Base结尾,接口以大写字母I开头.

6.       If和While等判断语句须使用{},除非只有一条语句并和if语句同一行

7.       代码中推荐的变量命名规则排列顺序为:大驼峰,小驼峰,下划线.

例如推荐使用顺序ParaName>paraName>para_name. 一般的私有成员变量推荐使用小驼峰或者下划线开头,局部变量推荐使用小驼峰和下换线命名法.

8.       使用Stream流时须用using语句调用, 对于存在导致程序溢出的代码,必须使用try…Catch包裹

9.       一些常识性代码,不需要写注释

10.   只要合适,在变量名的末尾追加计算限定符(Avg、Sum、Min、Max、Index)

11.   无特殊需求,注释应该在代码上方另起新行,而不能在代码右侧

12.   每个新的代码文件头部应该包含代码的主要信息,如

////////////////////////////////////////////

// 类名 DemoClass.cs

// 功能:

// 创建:日期 作者

// 日期 作者 功能变动

// 日期 作者 功能变动

/////////////////////////////////////////////



作者:songshizhao 发表于:2017-09-11T12:47:01 访问量:1300