代码编写规范说明书

《代码编写规范说明书》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、代码编写规范说明书代码编写规范说明书（c#.net与asp.net）转Postedon2007-02-0415:16wander阅读(331)评论(0)编辑收藏目录1目的2范围3注释规范　　3.1概述　　3.2自建代码文件注释　　3.3模块（类）注释　　3.4类属性注释　　3.5方法注释　　3.6代码间注释4命名总体规则5命名规范　　5.1变量（Variable）命名　　5.2常量命名　　5.3类（Class）命名　　5.4接口（Interface）命名　　5.5方法（Method）命名　　5.6名称空间Namespace）命名6编码规则　　6.1

2、错误检查规则　　6.2大括号规则　　6.3缩进规则　　6.4小括号规则　　6.5IfThenElse规则　　6.6比较规则　　6.7Case规则　　6.8对齐规则　　6.9单语句规则　　6.10单一功能规则　　6.11简单功能规则　　6.12明确条件规则　　6.13选用FALSE规则　　6.14独立赋值规则　　6.15定义常量规则　　6.16模块化规则　　6.17交流规则7编程准则　　7.1变量使用　　7.2数据库操作　　7.3对象使用　　7.4模块设计原则　　7.5结构化要求　　7.6函数返回值原则8代码包规范　　8.1代码包的版本号　　8.2代

3、码包的标识　　9代码的控制　　9.1代码库/目录的建立　　9.2代码归档10输入控制校验规则　　10.1登陆控制　　10.2数据录入控制附件1：数据类型缩写表附件2：服务器控件名缩写表1目的一.为了统一公司软件开发设计过程的编程规范二.使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作2范围本规范适用于开发组全体人员，作用于软件项目开发的代码

4、编写阶段和后期维护阶段。3注释规范3.1概述a)注释要求英文及英文的标点符号。b)注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。c)每行注释的最大长度为100个字符。d)将注释与注释分隔符用一个空格分开。e)不允许给注释加外框。f)编码的同时书写注释。g)重要变量必须有注释。h)变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。如：intm_iLevel,m_iCount;//m_iLevel....treelevel//m_iCount....countoftreeitemsstringm_strSq

5、l;//SQLi)典型算法必须有注释。j)在循环和逻辑分支地方的上行必须就近书写注释。k)程序段或语句的注释在程序段或语句的上一行l)在代码交付之前，必须删掉临时的或无关的注释。m)为便于阅读代码，每行代码的长度应少于100个字符。3.2自建代码文件注释对于自己创建的代码文件（如函数、脚本），在文件开头，一般编写如下注释：/******************************************************FileName:Copyright(c)2004-xxxx*********公司技术开发部Writer:createD

6、ate:Rewriter:RewriteDate:Impact:MainContent（FunctionName、parameters、returns）******************************************************/3.3模块（类）注释模块开始必须以以下形式书写模块注释：///