XXX公司代码编写规范.docxVIP

XXX公司 代码编写与规范 XX部 第一章 排版规范 第一条 程序块要采用缩进风格编写， 缩进的空格以统一的开发工具为准。 函数或过程的开始、 结构的定义及循环、 判断等语句中的代码都要采用缩进风格。 第二条 较长的语句（>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（??） { ?? // program code } If（??） { ?? // program code } 应如下书写 For（??） { ?? // program code } If（??） { ?? // program code } 第二章 注释规范 第六条 模块（类） 注释规范 ///<summary> /// 模块编号： <模块编号， 可以引用系统设计中的模块编号> /// 作用： <对此类的描述， 可以引用系统设计中的描述> /// 作者： 作者中文名 /// 编写日期： <模块创建日期， 格式： YYYY-MM-DD> ///</summary> 如果模块有修改， 则每次修改必须添加以下注释： ///<summary> /// Log 编号： <Log 编号,从 1 开始一次增加> /// 修改描述： <对此修改的描述> /// 作者： 修改者中文名 /// 修改日期： <模块修改日期， 格式： YYYY-MM-DD> ///</summary> 第七条 类属性注释规范 /// <summary> /// 属性说明 /// </summary> 第八条 方法（函数） 注释规范 /// <summary> /// 说明： <对该方法的说明> /// </summary> /// <param name="<参数名称>"><参数说明></param> /// <returns> ///<对方法返回值的说明， 该说明必须明确说明返回的值代表什么含义> /// </returns> 第九条 代码间注释规范 单行注释： //<单行注释> 多行注释： /*多行注释 1 多行注释 2 多行注释 3*/ 代码中遇到语句块时必须添加注释（if,for,foreach,……） ,添加的注释必须能 够说明此语句块的作用和实现手段（所用算法等等） 。 第十条 边写代码边注释， 修改代码同时修改相应的注释， 以保证注释与代码的一致 性。 不再有用的注释要删除。 第十一条 注释的内容要清楚、 明了， 含义准确， 防止注释二义性。 第三章 附则 第十二条 本规定由XXX公司XX部负责解释。 第十三条 本制度自颁布之日起发布执行。 第十四条 本规定与国家有关法律、法规不一致的以国家法律、法规为准。