代码说明文档模板
竭诚为您提供优质文档/双击可除
代码说明文档模板
篇一：代码说明书
系统编码规范
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;i
varchartest=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.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接
程序代码注释编写规范
程序代码注释编写规范 为提高控制程序的阅读性与可理解性，现制定相关代码程序代码注释编写的编写规范。 一般情况下，源程序有效注释量必须在20％以上，注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。 常规注释有以下两种方式。 单行:以"//"符号开始，任何位于该符号之后的本行文字都视为注释。 多行:以"/*"符号开始，以"*/"结束。任何介于这对符号之间的文字都视为注释。 一、说明性文件 说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。 示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************* COPYRIGHT (C), MicTiVo International. Co., Ltd. File NAME: // 文件 Author: Version: Date: // 作者、版本及完成日期 DESCRIPTION: // 用于详细说明此程序文件完成的主要功能，与其他模块 // 或函数的接口，输出值、取值范围、含义及参数间的控 // 制、顺序、独立或依赖等关系 Others: // 其它内容的说明 Function List: // 主要函数列表，每条记录应包括函数名及功能简要说明 1.... History: // 修改历史记录列表，每条修改记录应包括修改日期、修改 // 者及修改内容简述 1. Date: Author: Modification: 2. .. *************************************************/ 二、源文件头 源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。 示例：下面这段源文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。 /************************************************************ COPYRIGHT (C), MicTiVo International. Co., Ltd. FileName: Author:
程序设计报告模板
北京化工大学计算机科学与技术专业2014程序设计实训报告 题目：个人记账软件 专业：计算机科学与技术 班级：计科1305 指导教师：江志英
2014程序设计实训任务书
目录 2014程序设计实训任务书...................................... 错误!未定义书签。目录..................................................... 错误!未定义书签。第一章需求分析.............................................. 错误!未定义书签。 引言............................................... 错误!未定义书签。 任务概述........................................... 错误!未定义书签。 数据描述........................................... 错误!未定义书签。 功能需求........................................... 错误!未定义书签。 运行需求........................................... 错误!未定义书签。 任务计划........................................... 错误!未定义书签。第二章概要设计.............................................. 错误!未定义书签。 总体设计........................................... 错误!未定义书签。 面向对象设计....................................... 错误!未定义书签。 运行界面设计....................................... 错误!未定义书签。第三章详细设计.............................................. 错误!未定义书签。 ........................................................ 错误!未定义书签。第四章测试分析............................................. 错误!未定义书签。第五章用户手册（可选）..................................... 错误!未定义书签。第六章课程设计总结.......................................... 错误!未定义书签。附录：程序代码（仅电子版需要、纸质版不需要）................. 错误!未定义书签。
程序文件模板
修 订 页 序号 文件编号 修改 章节/页码 修订 内容 修订人 批准人 日 期 1 NCJW －CX 全文 四川省南充精神卫生中心 程序文件 编 号 NCJW-CX 修改状态 第1次修改 程序文件修订页 版 本 A 页 次 第1页 共1页 四川省南充精神卫生中心 编 号 NCJW-CX
程序文件 程序文件目录版本 A 页次 序号编号文件名称页数 1 NCJW-CX-01 文件控制程序 2 NCJW-CX-02 质量记录控制程序 3 NCJW-CX-03 内部沟通控制程序 4 NCJW-CX-04 管理评审控制程序 5 NCJW-CX-05 人力资源管理控制程序 6 NCJW-CX-06 设备、器械管理控制程序 7 NCJW-CX-07 工作环境管理控制程序 8 NCJW-CX-08 合同评审管理控制程序 9 NCJW-CX-09 医患沟通控制程序 10 NCJW-CX-10 医疗纠纷控制程序 11 NCJW-CX-11 采购控制程序 12 NCJW-CX-12 门诊诊疗服务控制程序 13 NCJW-CX-13 急诊诊疗服务控制程序 14 NCJW-CX-14 住院诊疗控制程序 15 NCJW-CX-15 手术麻醉管理控制程序 16 NCJW-CX-16 医疗会诊管理控制程序 17 NCJW-CX-17 医技科室管理控制程序 18 NCJW-CX-18 医院感染控制程序 19 NCJW-CX-19 标识和可追溯性控制程序 20 NCJW-CX-20 临床护理服务控制程序 21 NCJW-CX-21 异常情况紧急处理程序 22 NCJW-CX-22 医疗计量器具管理程序 23 NCJW-CX-23 医疗设计控制程序 24 NCJW-CX-24 患者提供财产控制程序 25 NCJW-CX-25 患者满意度调查评估程序 26 NCJW-CX-26 内部审核控制程序 27 NCJW-CX-27 数据分析控制程序 28 NCJW-CX-28 纠正和预防措施控制程序 29 NCJW-CX-29 医疗服务质量检查控制程序 30 NCJW-CX-30 不合格医疗服务控制程序 31 NCJW-CX-01 文件控制程序 32 NCJW-CX-02质量记录控制程序 33 NCJW-CX-03内部沟通控制程序 34 NCJW-CX-04 管理评审控制程序 35 NCJW-CX-05 人力资源管理控制程序 36 NCJW-CX-06 设备、器械管理控制程序
程序设计文档
蛇吞食程序设计 【摘要】本游戏设计采用MFC编程，对键盘消息、定时器消息、图形界面等三个主要模块进行设计，可视化强。本游戏初始编写比较基础，程序代码相对简单。此游戏具有可靠性，安全性以及低成本等特点。 【关键词】键盘消息定时器消息图形界面 一．功能模块的划分 整个界面由一个长宽为540*540的矩形框（此为蛇的活动范围和食物出现的范围）、分数栏等构成。 键盘消息：按动键盘↑、↓、←、→使蛇的方向进行改变。 定时器消息：整个程序只用到一个定时器，在OnStart()里对定时器进行设定SetTimer(1,100,NULL)，在OnTimer()中对蛇和食物进行处理：第一关：将block 设置为1，当分数超过10分蛇不能通过墙壁；第二关：将block设置为2，设置
障碍物并且蛇不能碰到墙壁，但有最低分数为20分。 图形界面：位图处理：在OnDraw（）里面画出蛇和食物的图片。一张蛇图有四个方向的四条蛇，改变x_org（横坐标）、y_org（纵坐标）、t_org（宽度）、b_org （长度）、t_org1（蛇图显示区域的横坐标）的值来控制蛇不同方向的运动，用rand（）来随机产生食物的图片。在执行Invalidate（）时自动显示位图的不同状态。菜单功能模块：Set包含Start、Gameover、First、Second。Start启动定时器、Gameover关掉定时器并且退出游戏界面。First和Second分别选择游戏级别。Help 是游戏的说明。 二．程序流程 程序流程： 1.程序执行Ondraw()函数部分，显示出蛇朝右的图片和食物图片。 2.选择级别First或者Second，此时程序会调用OnFirst（）或OnSecond（） 改变block的值。若选择的First，block将赋值为1，然后选择Start程序 调用OnStart（）函数，将m_nStart赋值为1，程序将执行第一关的代码， 蛇能够穿墙而过。如果分数超过10分（即score>10），游戏将自动升级， 蛇不能穿墙而过，碰到墙壁蛇将死亡；若选择的Second，block将赋值 为2，然后选择Start程序调用OnStart（）函数，将m_nStart赋值为1，程序将执行第二关的代码，蛇不能够穿墙而过，而且在活动范围内有障 碍物，但有最低分20分，若碰到墙壁或障碍物蛇将死亡。 3.在选择Start后，程序自动启动定时器，执行OnTimer（）部分的代码， 若block=1，执行第一关的代码，蛇可以分别在四个方向上运动，score 自动加分直到超过10，则改变代码蛇不能撞墙。若撞墙则KillTimer（） 并将score置为0； 4.在执行OnTimer（）部分的代码时，要不断执行Invalidate（）进行刷新， 然后调用Ondraw（），画出不同状态下的图形。 5.选择GameOver选项，调用OnEnd（）函数，使m_nstart=0, KillTimer（） 并且退出游戏。
程序员代码编写标准指南汇总
Delphi 6 程序员代码编写标准指南 一、序言 二、通用源代码格式规则 2.1 缩格 2.2 页边空格 2.3 Begin…End 配对 2.4 代码文件中通用符号含义 三、Object Pascal 3.1 括号 3.2 保留字和关键字 3.3 过程和函数（例程） 3.3.1 命名/格式化 3.3.2 形式参数 3.3.2.1 格式化 3.3.2.2 命名 3.3.2.3 参数的排序 3.3.2.4 常量参数 3.3.2.5 名称的冲突 3.4 变量 3.4.1 变量的命名和格式 3.4.2 局部变量 3.4.3 全局变量的使用 3.5 类型 3.5.1 大写约定 3.5.1.1 浮点指针类型 3.5.1.2 枚举类型 3.5.1.3 变数和ole变数类型 3.5.2 结构类型 3.5.2.1 数组类型 3.5.2.2 记录类型 3.6 语句 3.6.1 if 语句 3.6.2 case 语句 3.6.2.1 一般性话题 3.6.2.2 格式 3.6.3 while 语句 3.6.4 for 语句 3.6.5 repeat 语句
3.6.6 with 语句 3.6.6.1 一般话题 3.6.6.2 格式 3.7 结构异常处理 3.7.1 一般话题 3.7.2 try…finally的使用 3.7.3 try…except的使用 3.7.4 try…except…else的使用 3.8 类类型 3.8.1 命名和格式 3.8.2 域 3.8.2.1 命名/格式 3.8.2.2 可视化 3.8.3 方法 3.8.3.1 命名/格式 3.8.3.2 使用静态的方法 3.8.3.3 使用虚拟/动态的方法 3.8.3.4 使用抽象的方法 3.8.3.5 属性存取方法 3.8.4 属性 3.8. 4.1 命名/格式 3.8. 4.2 使用存取的方法 四、文件 4.1 工程文件 4.1.1 命名 4.2 窗体文件 4.2.1 命名 4.3 数据模板文件 4.3.1 命名 4.4 远端数据模板文件 4.4.1 命名 4.5 Unit文件 4.5.1 通用Unit结构 4.5.1.1 unit的名字 4.5.1.2 uses子句 4.5.1.3 interface部分 4.5.1.4 implementation部分 4.5.1.5 initialization部分 4.5.1.6 finalization部分 4.5.2 窗体单元
程序说明文档
程序说明文档 小组成员：周勍、麦娥英、曾启飞、李琰 本程序为控制台程序，没有设计界面，所有的数据输入和输出需要在代码中指定路径和文件名。 本程序分为两大部分，样本训练和检测识别。 1.样本训练：（文件夹pichuli用于训练特征计算） （1）输入avi视频，调用函数Video_to_image，将视频数据按帧数截成100张图像，并存储起来； （2）批量导入100张训练样本 （3）对训练样本进行颜色分割； （4）对（3）中结果图像进行高斯滤波和边缘检测，并转化为灰度图像，（5）利用findcontour函数进行椭圆拟合，检测出车牌标志 （6）利用calculatevectors函数进行特征向量的计算，并保存为txt （7）输入（6）保存的txt（见X:\空间智能数据处理\pichuli\训练向量程序部分运行说明.txt） （8）设计网络参数： CvANN_MLP_TrainParamsparams; params.term_crit = cvTermCriteria(CV_TERMCRIT_ITER + CV_TERMCRIT_EPS, 5000, 0.01); params.train_method=CvANN_MLP_TrainParams::BACKPROP; params.bp_dw_scale=0.1; params.bp_moment_scale=0.1; （9）设定预期输出值、网络层数等 （10）调用train接口进行训练，得到一个txt，将其保存下来。 （步骤（7）-（10）为Training_MLP函数内容） 2.检测识别（文件夹test用于检测识别算法） （1）通过修改路径代码，输入检测样本，并对其进行检测，即1中的（3）-（6）步骤； （2）输入txt数据后，调用predict接口进行预测，得到预测后的向量 （3）对预测向量进行类别判定，如下代码：
软件著作权源程序代码