搜索
软件项目文档编制说明根据调度系统项目开发中的情况总结如下文档编制的说明。此文档是对java平台下的开发进行说明。一、注释注释为程序代码中的注解及说明。开发人员在编写代码时，必须有相应的注释，注释应当全面、清晰，能够有效地协助维护人员以及其他项目成员了解程序内容，读懂代码。Java平台下使用的文件主要有：jsp、java、js、html、inc、css等。其中jsp、Java、js文件使用较多。以下进行分类说明：1、jsp文件注释Jsp文件中java代码部分注释格式主要有：/**/（多行）、//（单行）两种。Jsp注释为%----%Html注释为!----。JavaScript注释与java注释类似。具体的注释方式说明可以查询有关资料。1）jsp页面应该有该页面功能的设计思路，程序流程的说明，必要时应该加上业务的说明。2）对一些关键点进行注释。注释的原则是尽可能详细，利于其它维护人员读懂程序。3）对于JavaScript代码的注释应该描述每个方法的功能，以及方法体内实现细节的说明。4）HTML代码注释对一些控件的作用以及复杂显示功能进行说明。2、java文件注释Java文件常用的注释有三种：文档注释，格式：/***/。此类注释可以生成java帮助文档。块注释，格式：/**/。单行注释，格式：//。1）文档注释。文档注释可以通过javadoc生成文档，一般对类、属性和方法进行文档注释，它们生成的文档分别是说明紧接其后的类、属性、方法。标记用于作用@author对类的说明标明开发该类模块的作者@version对类的说明标明该类模块的版本@see对类、属性、方法的说明参考转向，也就是相关主题@param对方法的说明对方法中某参数的说明@return对方法的说明对方法返回值的说明@throws对方法的说明对方法可能抛出的异常进行说明类注释。说明类的名称、功能、版本，创建日期等。如：/***类名:Huanmonthsc.classpbr*功能描述:环境统计月报的javabean*版本号:1.0*作者:时阳*创建日期:2008-3-5*最后修改人:*最后修改日期:*/说明：对于“功能描述”应根据具体的类进行编写，如果比较复杂，或作为某些类父类，或使用较为特殊等情况应该增加说明，描述清楚。2）方法注释功能说明：说明函数功能，何处使用。参数：内容，数据类型，如果是数组，应说明数组中各项内容。返回值：说明返回值数据类型。3）属性注释说明属性的含义。4）方法体内注释一般使用块注释（/**/）或单行注释（//），对逻辑较为复杂的内容进行说明，对于业务流程较多的也需要说明。注释的原则尽可能详细，利于其它维护人员读懂程序，对关键点一定要说明。