代码编写规范.docVIP

代码编写规范

排版规范

程序块要采用缩进风格编写，缩进的空格以统一的开发工具为准。函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。

较长的语句（100字符）要提成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要警醒适当的缩进，是排版整齐，语句可读。

不允许把多个短语句写在一行中，即一行只写一条语句。

示例:如下例子为不符合规范

rng.Font.Size=10;rng.Font.Name=宋体;

应如下书写

rng.Font.Size=11;

rng.Font.Name=宋体;

If、for、do、while、case、switch、default等语句自占一行，且If、for、do、while等语句的执行语句部分无论多少都要加括号{}。

示例：如下例子不符合规范

If（Strtxt==NULL）return；

应如下书写

If（Strtxt==NULL）

{

return；

}

程序块的分界符（如C++/C#语言中的‘{’和‘}’）应各自独占一行并且位于同一列，同时与引用它们的语句左对齐。

示例：如下例子不符合规范

For（……）{

……//programcode

}

If（……）

{

……//programcode

}

应如下书写

For（……）

{

……//programcode

}

If（……）

{

……//programcode

}

注释规范

模块（类）注释规范

///summary

???????///模块编号：模块编号，可以引用系统设计中的模块编号

???????///作用：对此类的描述，可以引用系统设计中的描述

???????///作者：作者中文名

???????///编写日期：模块创建日期，格式：YYYY-MM-DD

???????////summary

假如模块有修改，则每次修改必须添加以下注释：

????????///summary

????????///Log编号：Log编号,从1开始一次增长

????????///修改描述：对此修改的描述

????????///作者：修改者中文名

????????///修改日期：模块修改日期，格式：YYYY-MM-DD

????????////summary

?

类属性注释规范

????????///summary

????????///属性说明

////summary

方法（函数）注释规范

????????///summary

????????///说明：对该方法的说明

????????////summary

????????///paramname=参数名称参数说明/param

????????///returns

????????///对方法返回值的说明，该说明必须明确说明返回的值代表什么含义

????????////returns

?

代码间注释规范

单行注释：

//单行注释

多行注释：

???????/*多行注释1

?????????多行注释2

?????????多行注释3*/

代码中碰到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须可以说明此语句块的作用和实现手段（所用算法等等）。

边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

注释的内容要清楚、明了，含义准确，防止注释二义性。

对于所有物理含义的变量、常量，假如其命名不是充足自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量的注释应放在其上方相邻位置或右方。

注释与所描述内容进行同样的缩排。

示例：如下例子不符合规范

VoidExampleFun（void）

{

//codeonecomments

CodeBlockone

//codetwocomments

CodeBlock

}

应改为如下布局

VoidExampleFun（void）

{

//codeonecomments

CodeBlockone

//codetwocomments

CodeBlock

}

避免在同一行代码或表达式中间插入注释

标记符命名规范

1．变量命名规则。变量的命名要清楚、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。

变量命名：

成员变量：m_

局部变量：以小写字母开头

·类、属性及方法：以大写字母开头，后续单词首字母大写

参考实例：initBorderColor(局部成员变