代码编写规范 一、 排版规范 1. 程序块要采用缩进风格编写,缩进的空格以统一的开发工具为准。函数或过 程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。 2. 较长的语句(>100字符)要分成多行书写,长表达式要在低优先级操作符 处划分新行,操作符放在新行之首,划分出的新行要警醒适当的缩进,是排 版整齐,语句可读。 3. 不允许把多个短语句写在一行中,即一行只写一条语句。 示例:如下例子为不符合规范 rng.F on t.Size = 10; rng.Fo nt.Name =\宋体\应如下书写 rn g.F on t.Size = 11; rng.F on t.Name =\宋体\4. If、for、do、while、case switch、default 等语句自占一行,且 If、for、 do、while等语句的执行语句部分无论多少都要加括号 示例:如下例子不符合规范 If (Strtxt==NULL ) return; 应如下书写 If (Strtxt==NULL ) { return; } 5. 程序块的分界符(如 C++/C#语言中的‘ {'和‘}')应各自独占一行并且 位于同一列,同时与引用它们的语句左对齐。 示例:如下例子不符合规范 For (……){ {}。 ... // program code } If (……) { .. // program code } 应如下书写 For ( .. ) { ... // program code } If (……) { ... // program code } 二、 注释规范 1. 模块(类)注释规范 〃/
///修改日期: <模块修改日期,格式:YYYY-MM-DD> /// 2. 类属性注释规范
III
III 3. 方法(函数)注释规范
III
III说明: <对该方法的说明> III
III vparam name=\参数名称 >\参数说明 > III
III<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义 III
>
4. 代码间注释规范 单行注释:
II<单行注释> 多行注释: I*多行注释1 多行注释2 多行注释3*I
代码中遇到语句块时必须添加注释(if,for,foreach, 能
够说明此语句块的作用和实现手段(所用算法等等)。
?)…,添加的注释必须
代码编写规范范本
![](/skin/haowen/images/icon_star.png)
![](/skin/haowen/images/icon_star.png)
![](/skin/haowen/images/icon_star.png)
![](/skin/haowen/images/icon_star.png)