代码规范(审查版)

《代码规范(审查版)》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、1 目的为了统一公司软件开发的设计过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性，便于交流和维护，特制定此规范。2 范围本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。3 注释规范3.1 概述a)  注释要求英文及英文的标点符号。b)  注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。c)  每行注释的最大长度为100个字符。d)  将注释与注释分隔符用一个空格分开。e)  不允许给注释加外框。f)  编码的同时书写注释。g)  重要变量必须有注释。h)  变量注

2、释和变量在同一行，所有注释必须对齐，与变量分开至少两个“Tab”键。如：int m_iLevel,m_iCount;    //m_iLevel....treelevel//m_iCount....countoftreeitemsstringm_strSql;           //SQLi)   典型算法必须有注释。j)   在循环和逻辑分支地方的上行必须就近书写注释。k)   程序段或语句的注释在程序段或语句的上一行l)   在代码交付之前，必须删掉临时的或无关的注释。m)   为便于阅读代码，每行代码的长度应少于100个字符。3.2

3、  自建代码文件注释对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：/******************************************************FileName:Copyright (c) 2004-xxxx*********公司技术开发部Writer:createDate:Rewriter:RewriteDate:Impact:MainContent（FunctionName、parameters、returns）***********************************

4、*******************/3.3  模块（类）注释模块开始必须以以下形式书写模块注释：///

5、Start1：/*原代码内容*////End1：将原代码内容注释掉，然后添加新代码使用以下注释：///Addedby：    Adddate：<添加日期，格式：YYYY-MM-DD>  Start2：新代码内容///End2：如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下注释：///

6、3.4   类属性注释在类的属性必须以以下格式编写属性注释：///