代码说明文档模板Word格式.docx

代码说明文档模板Word格式.docx

《代码说明文档模板Word格式.docx》由会员分享，可在线阅读，更多相关《代码说明文档模板Word格式.docx（5页珍藏版）》请在冰豆网上搜索。

（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（）;

}

　　4.2.行注释

　　用户名非空验证+长度验证+合法性验证

　　}

　　//用户名输入合法性验证

　　for（vari=0;

i　　varchartest=name.value.tolowercase（）.charat（i）;

　　if（（!

（chartest>

=09））az））_））{

会员名包含非法字符，只能包括a-z、0-9和下划线"

}}

　　returntrue;

　　//密码非空验证+确认验证+长度验证functioncheckpass（）{

　　varpass=document.myform1.txtpass;

varrpass=document.myform1.txtRpass;

if（pass.value=="

密码不能为空"

pass.focus（）;

　　}elseif（pass.value.length12）{alert（"

密码长度为6-12个字符"

pass.select（）;

　　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四、详细设计.................................................................................................................................................8

　　4.1xxeas接口....................................................................................................................................8

　　1.概述

　　金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。

　　1.1读者

　　本文读者对象为业务管理人员、系统设计、开发人员、测试人员。

　　1.2图例

　　本文中如未进行特殊说明，各图标代表的含义如下：

　　表示流程走向；

　　1.3目的

　　本文档是媒讯ctc系统与eas系统接口的需求及设计方案相关文档，可用于指导开发、测试工作和作为验收相关依据文档。

　　二、业务现状

　　待补充

　　三、概要设计

　　3.1接口通讯方式

　　金蝶eas与媒讯ctc系统之间通讯采用webservice方式进行数据传输。

3.2通讯内容定义

　　对于记录型的大对象，在通讯时，采用string型的xml格式的参数进行传递。

对于其他非记录型的对象，在通讯时，可采用非xml格式的参数进行传递，也可使用多个参数。

具体格式，请参照每个接口的通讯用例说明。

3.3媒讯ctc系统提供接口使用范例

　　待补充。

　　3.4金蝶eas提供接口使用范例3.4.1规范说明

　　eas通过webservice接口与异构系统通信。

easwebservice全部是使用java编写的，其接口描述符合wsdl国际标准，其数据描述符合xsd国际标准。

　　本次提供的接口除系统登录接口外，其他接口都需要调用登录接口，以便将登陆的sessionid信息放入到soap的headeR报文中。

3.4.2使用示例

　　金蝶在eas上发布webservice服务，提供wsdl文件供客户端下载，其他业务系统根据下载的wsdl文件，产生客户端。

　　建议使用axis2来生成客户端代理。

　　篇三：

技术文档说明书的模板

　　xxxx系统

　　20xx年3月25日

　　更新记录

　　第一章前言.....................................................-3-

　　1.系统名称...............................................-3-2.需求提出单位...........................................-3-3.内容简介...............................................-3-4.参考资料...............................................-3-第二章程序总体介绍...............................