[实用参考]代码说明文档.doc

@亲爱的php/计算机语言爱好者，开发者好，希望在这里你能收获到你需要的，祝你工作顺利，生活愉快！@姜祖斌，web爱好者，开发者@喜欢和业界的普一起交流，分享，关注互联网，关注媒体，关注开发，关注产品，关注技术@感兴趣的朋友可以和我一起交流技术的精华@weibo:/yangpage@mail/gtalk:jiangzubin1989@@msn:jiangzubin1989@@qq:757576387@honepage：/@facebook:https:///zubin.jiangphp代码规范说明文档命名规则：采用驼峰标识，尽量做到见名知义PHP编码规范与原则：//命名：类，方法，函数，变量，注释：开发中难免留下一些临时代码和调试代码，此类代码必须添加注释，以免日后遗忘。

所有临时性、调试性、试验性的代码，必须添加统一的注释标记“//debug”并后跟完整的注释信息，这样可以方便在程序发布和最终调试前批量检查程序中是否还存在有疑问的代码。

如：$flag = TRUE; //debug 这里不能确定是否需要对$flag进行赋值缩进/空格：使用四个空格为每层次缩进。

对于最大缩进层数，并没有一个固定的规矩，假如缩进层数大于五层的时候，考虑着将代码因数分解。

运算符、小括号、关键词和函数：不要把小括号和关键词紧贴在一起，要用空格隔开它们；不要把小括号和函数名紧贴在一起；除非必要，不要在Return返回语句中使用小括号。

如：if (condition) {}大括号{}、if和switch：首括号与关键词同行，尾括号与关键字同列；if结构中，if和elseif与前后两个圆括号同行，左右各一个空格，所有大括号都单独另起一行。

另外，即便if后只有一行语句，仍然需要加入大括号，以保证结构清晰；总是将恒量放在等号/不等号的左边。

switch结构中，通常当一个case块处理后，将跳过之后的case块处理，因此大多数情况下需要添加break。

源代‎码说‎明文‎档模‎板‎篇‎一：‎程‎序代‎码文‎档模‎板‎代码‎文档‎模板‎整‎体的‎概述‎:‎系统‎运行‎要求‎主‎要功‎能介‎绍.‎数‎据库‎部分‎:‎程序‎代码‎部分‎:‎程序‎入口‎程‎序到‎配置‎清单‎程‎序的‎依赖‎环境‎详情‎程‎序的‎启动‎方式‎程‎序的‎注意‎事项‎数‎据库‎地址‎:‎数据‎库涉‎及到‎的库‎数‎据库‎设计‎到的‎表‎所有‎表字‎段的‎诠释‎所‎有表‎的示‎例数‎据篇‎二：‎代‎码说‎明书‎系‎统编‎码规‎范‎1‎.‎目的‎为‎了统‎一开‎发过‎程中‎关于‎代码‎编写‎时的‎编写‎规范‎和具‎体开‎发工‎作时‎的编‎程规‎范，‎保证‎代码‎的一‎致性‎,便‎于交‎流和‎维护‎，特‎制定‎此规‎范。

‎‎2.‎适‎用范‎围‎本规‎范适‎用于‎开发‎组全‎体人‎员，‎为详‎细设‎计，‎代码‎编写‎和代‎码审‎核提‎供参‎考和‎依据‎。

‎3‎.‎代码‎格式‎在‎编写‎代码‎过程‎中，‎建议‎遵循‎以下‎规则‎。

‎（‎1）‎缩进‎规‎则：‎使‎用四‎个空‎格作‎为每‎层次‎代码‎的缩‎进值‎。

‎（‎2）‎在括‎号对‎对齐‎的位‎置垂‎直对‎齐左‎右括‎号，‎如：‎F‎o r‎(i‎=0‎;i‎++‎)‎{‎….‎}‎‎（3‎）沿‎逻辑‎结构‎行缩‎进代‎码，‎如：‎I‎f…‎t h‎e n‎I‎f…‎t h‎e n‎…‎E‎l s‎e‎…‎E n‎d‎i f‎E‎l s‎e‎…‎E n‎d‎i f‎‎（4‎）为‎了防‎止在‎阅读‎代码‎时左‎右滚‎动代‎码编‎辑器‎，每‎行代‎码或‎注释‎不得‎超过‎一个‎显示‎屏。

‎‎（5‎）当‎一行‎分别‎为几‎行时‎，通‎过将‎串联‎运算‎符放‎在每‎行的‎末尾‎而不‎是开‎头，‎清楚‎地表‎示没‎有后‎面的‎行是‎不完‎整的‎。

‎（‎6）‎C a‎s e‎规‎则：‎d‎e f‎a u‎l t‎c‎a s‎e‎总应‎该存‎在，‎如果‎不允‎许到‎达，‎则应‎该保‎证：‎若‎到达‎了就‎会触‎发一‎个错‎误。

竭诚为您提供优质文档/双击可除代码说明文档模板篇一：代码说明书系统编码规范1.目的为了统一开发过程中关于代码编写时的编写规范和具体开发工作时的编程规范，保证代码的一致性,便于交流和维护，特制定此规范。

2.适用范围本规范适用于开发组全体人员，为详细设计，代码编写和代码审核提供参考和依据。

3.代码格式在编写代码过程中，建议遵循以下规则。

（1）缩进规则：使用四个空格作为每层次代码的缩进值。

（2）在括号对对齐的位置垂直对齐左右括号，如：For(i=0;i++){….}（3）沿逻辑结构行缩进代码，如：if…thenif…then…else…endifelse…endif（4）为了防止在阅读代码时左右滚动代码编辑器，每行代码或注释不得超过一个显示屏。

（5）当一行分别为几行时，通过将串联运算符放在每行的末尾而不是开头，清楚地表示没有后面的行是不完整的。

（6）case规则：defaultcase总应该存在，如果不允许到达，则应该保证：若到达了就会触发一个错误。

case的选择条件最好使用int或string类型。

（7）对齐规则：变数的申明和初始化都应对齐。

4.注释规范4.1.块注释//用户名非空验证+长度验证+合法性验证functioncheckusername(){varname=document.myform1.txtuser;if(name.value=="") {alert("请输入用户名");name.focus();returnfalse;}elseif(name.value.length16){//用户名长度验证alert("用户名输入的长度4-16个字符");name.select();returnfalse;}4.2.行注释用户名非空验证+长度验证+合法性验证functioncheckusername(){varname=document.myform1.txtuser;if(name.value=="") {alert("请输入用户名");name.focus();returnfalse;}elseif(name.value.length16){//用户名长度验证alert("用户名输入的长度4-16个字符");name.select();returnfalse;}//用户名输入合法性验证for(vari=0;ivarchartest=name.value.tolowercase().charat(i);if((!(chartest>=09))az))_)){alert("会员名包含非法字符，只能包括a-z、0-9和下划线");name.select();returnfalse;}}returntrue;}//密码非空验证+确认验证+长度验证functioncheckpass(){varpass=document.myform1.txtpass;varrpass=document. myform1.txtRpass;if(pass.value==""){alert("密码不能为空");pass.focus();returnfalse;}elseif(pass.value.length12){alert("密码长度为6-12个字符");pass.select();returnfalse;}4.3.尾随注释//获取用户名文本框中的值intm=4;//获取密码框中的值//用户名长度验证4.4.注释哪些部分篇二：项目接口需求及设计说明文档(模板)客户化开发需求规格说明书媒讯集团eas项目ctc与eas接口需求及设计说明书文档作者：创建日期：20xx-05-10确认日期：当前版本：1.0拷贝数量：1审批签字:客户方：实施方：文档控制目录1.概述................................................. ................................................... .............................................41.1读者................................................. ................................................... ..............................................41.2图例................................................. ................................................... ..............................................41.3目的................................................. ................................................... ..............................................4二、业务现状................................................. ................................................... .............................................5三、概要设计................................................. ................................................... (5)3.1接口通讯方式................................................. ..................................................................................53.2通讯内容定义................................................. ................................................... ...............................53.3媒讯ctc系统提供接口使用范例................................................. . (53).4金蝶eas提供接口使用范例................................................. ................................................... ......53.5媒讯ctc系统提供接口服务地址................................................. . (73).6金蝶eas提供接口服务地址................................................. ................................................... ......73.7接口需求................................................. ................................................... .......................................7四、详细设计................................................. ...................................................。

JAVA代码规范本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。

本文档中没有说明的地方，请参看SUN Java标准代码规范。

如果两边有冲突，以SUN Java标准为准。

1. 标识符命名规范1.1 概述标识符的命名力求做到统一、达意和简洁。

1.1.1 统一统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。

统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。

即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。

1.1.2 达意达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier, OrderPaymentGatewayService等；而supplier1, service2，idtts等则不是好的命名方式。

准确有两成含义，一是正确，而是丰富。

如果给一个代表供应商的变量起名是order，显然没有正确表达。

同样的，supplier1, 远没有targetSupplier意义丰富。

1.1.3 简洁简洁是指，在统一和达意的前提下，用尽量少的标识符。

如果不能达意，宁愿不要简洁。

比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。

省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。

1.1.4 骆驼法则Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。

比如: supplierName, addNewContract，而不是supplier_name, add_new_contract。

代码开发规对于新增代码或者修改的代码应按代码规要求进行编写。

一、通用规1.1 Kconfig文件:格式：注释部分以#开头,空一格开始写注释容。

一级容“config”顶头开始二级容开头空白处为一个制表符，相当于8个空格三级容开头空白处为一个制表符再加两个空格，即比二级容缩进两个空格容：help说明部分必须有，为第三级容，需说明帮助信息，分段的容需空一行，每块config间空一行。

以文件系统fs下的Kconfig示例如下图1.1,‘□’代表一个空格，短横线‘－’所占一行代表一个空行:图1.1##□File system configuration#----------------------------------------------------------------menu "File systems"----------------------------------------------------------------config EXT2_FS□□□□□□□□tristate "Second extended fs support"□□□□□□□□help□□□□□□□□□□Ext2 is a standard Linux file system for hard disks.□□□□□□□□□□To compile this file system support as a module, choose □□□□□□□□□□M here: the module will be called ext2. Be aware □□□□□□□□□□however that the file system of your root partition □□□□□□□□□□(the one containing the directory /) cannot be compiled □□□□□□□□□□as a module, and so this could be dangerous.----------------------------------------------------------------□□□□□□□□□□If unsure, say Y.-----------------------------------------------------------------config EXT2_FS_XATTR□□□□□□□□bool "Ext2 extended attributes"□□□□□□□□depends on EXT2_FS□□□□□□□□help□□□□□□□□□□Extended attributes are name:value pairs associated□□□□□□□□□□with inodes by the kernel or by users (see the attr(5) □□□□□□□□□□manual page, or visit <acl.bestbits.at/> for □□□□□□□□□□details).-----------------------------------------------------------------□□□□□□□□□□If unsure, say N.1.2头文件.h和.c文件规说明格式：制表符宽度相当于8个空格1.2.1文件首部注释文件首部的注释用于说明文件信息，可选项目包括：文件所属模块主要函数实现作者信息信息软件说明以上容为可选信息，一个文件中不一定包含全部信息，由开发者根据重要性来确定。

4.1网页与数据库连接文件名称：conn.asp在使用asp语言建立网站时，常常需要用数据库记录一些信息，此时就需要用到asp连接数据库的代码连接数据库后便于进行数据添加删除等操作。

由于系统在每个页面要使用数据的时候都要建立与数据库的连接，则有很多代码是重复的，在这里首先设置一个连接数据库的文件，这样可以大大节省网页代码的重复编辑，在其他页面中用包含文件(<!-- #include file="conn.asp" -->)即可.Access数据库相对路径：data/cangkuxitong.mdbAccess数据库连接代码实现：set conn=server.createobject("adodb.connection")【默认连接数据库必须的要求】mypath=server.mappath("data/cangkuxitong.mdb")【数据库路径】conn.open "driver={microsoft access driver (*.mdb)};dbq="&mypath【连接程序】4.2管理登陆用户将登录用户名和登录口令输入后，通过post传输到验证页面，为使口令更加安全，口令通过md5加密后与数据库中的用户名和密码匹配，用户名和口令完全匹配后才可以通过验证，进入系统管理，并用session记录登录信息。

否则，自动跳转到登录窗口。

加密文件：md5.asp文件名称：checklogin.aspSql语句：select * from login where username='"&nowusername&"' and password='"&md5(nowpassword)&"'"【查询login表，条件是提交的用户名信息和加密后的密码】用户登录检测代码实现：<!-- #include file="conn.asp" -->【包含连接数据库文件】<!-- #include file="inc/md5.asp" -->【包含加密数据程序】<%nowusername=request.form("username")【接收用户名信息】nowpassword=request.form("password")【接收密码信息】sql="select * from login where username='"&nowusername&"' and password='"&md5(nowpassword)&"'"【查询login表，条件是提交的用户名信息和加密后的密码】set rs=conn.execute(sql)【执行查询】if rs.eof then【如果查询数据为空】%><script language=javascript>alert('用户名称或口令错误！')window.history.go(-1)</script>【提示错误，并返还上个页面】<%response.end【结束查询】end if【结束if】session("username")=nowusername【成功后赋值session，用此判断用户是否登录，默认时间为60秒】response.redirect "main.asp"【跳转到main.asp】%>4.3 模块功能结构实现4.3.1 入库管理文件名称：produit_add.asp分析实现：管理员将表单提交到本页，本页会根据数据库的信息来添加到产品总表格中。

目次内容提要 (1)格式说明： (1)等级分类： (1)类型分类： (1)【必须遵守】 (1)【规则1-10-1】零警告零异常 (1)【规则1-3-2】类的成员变量命名规则 (1)【规则1-3-3】全局变量命名规则 (2)【规则1-3-4】自定义类型名 (2)【规则1-9-5】文件头注释 (2)【规则1-9-6】头文件类成员属性的注释。

(3)【规则1-9-7】函数头的注释 (3)【规则1-9-8】函数体内注释 (3)【编程常识】 (4)【规则2-2-1】就近原则 (4)【规则2-2-2】指针与应用申明 (4)【规则2-5-3】公共变量 (4)【规则2-5-4】显示类型转换 (4)【规则2-6-5】可重入函数 (4)【规则2-6-6】有效性检测 (5)【规则2-6-7】非参数输入的有效性检测 (5)【规则2-6-8】函数出口的检测 (5)【规则2-7-9】使用SAFE_DELETE防止产生“野指针” (5)【规则2-8-10】基类的析构函数必须为虚析构函数 (6)【规则2-8-11】类的成员属性私有 (6)【规则2-8-12】this的使用 (6)【规则2-9-13】说明性文件的注释 (6)【规则2-5-18】右值说明 (6)【规则2-7-19】防止引用已经释放的内存空间。

(6)【规则2-7-20】内存使用原则 (6)【规则2-6-21】资源使用原则 (6)【规则2-5-23】变量引用原则 (7)【规则2-1-24】文件应与类设计相对应 (7)【规则2-1-25】不允许使用全局类类型变量 (7)【规则2-1-26】一类一头文件 (7)【规则2-2-27】分界符对齐 (7)【规则2-2-28】分界符内的代码块对齐 (7)【规则2-2-29】拆分方法 (7)【规则2-3-30】命名原则 (7)【规则2-3-31】显式原则 (7)【规则2-5-32】定义常量 (7)【规则2-6-33】const使用原则 (7)【规则2-9-34】注释与代码的一致性 (7)【规则2-2-35】{}使用原则 (7)【规则2-9-36】注释与所描述内容进行同样的缩排。

代码编写规范说明书（c#.net与）目录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 错误检查规则6.2 大括号规则6.3 缩进规则6.4 小括号规则6.5 If Then Else规则6.6 比较规则6.7 Case规则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 代码包的标识9 代码的控制9.1 代码库/目录的建立9.2 代码归档10 输入控制校验规则10.1 登陆控制10.2 数据录入控制附件1：数据类型缩写表附件2：服务器控件名缩写表1 目的一.为了统一公司软件开发设计过程的编程规范二.使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。

四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作2 范围本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。

3 注释规范3.1 概述a) 注释要求英文及英文的标点符号。

b) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。