档必须书写在类、域、构造函数、方法，以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下：
　　/**
　　* The doGet method of the servlet.
　　* This method is called when a form has its tag value method
　　* equals to get.
　　* @param request
　　*  the request send by the client to the server
　　* @param response
　　*  the response send by the server to the client
　　* @throws ServletException
　　*  if an error occurred
　　* @throws IOException
　　*  if an error occurred
　　*/
　　public void doGet (HttpServletRequest request, HttpServletResponse response)
　　throws ServletException, IOException {
　　doPost(request, response);
　　}
　　前两行为描述，描述完毕后，由@符号起头为块标记注释。更多有关文档注
　　释和javadoc的详细资料，参见javadoc的主页： http://java.sun.com/javadoc/index.html
　　4、javadoc注释标签语法
　　@author    对类的说明 标明开发该类模块的作者
　　@version   对类的说明 标明该类模块的版本
　　@see      对类、属性、方法的说明 参考转向，也就是相关主题
　　@param    对方法的说明 对方法中某参数的说明
　　@return    对方法的说明 对方法返回值的说明
　　@exception  对方法的说明 对方法可能抛出的异常进行说明
　　六、JAVA注释具体实现
　　1、源文件注释
　　源文件注释采用 /** …… */，在每个源文件的头部要有必要的注释信息，包括：文件名；文件编号；版本号；作者；创建时间；文件描述包括本文件历史修改记录等。中文注释模版：
　　/**
　　* 文 件 名 :
　　* CopyRright (c) 2008-xxxx:
　　* 文件编号：
　　* 创 建 人：
　　* 日    期：
　　* 修 改 人：
　　* 日   期：
　　* 描   述：
　　* 版 本 号：
　　*/
　　2、类（模块）注释：
　　类（模块）注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等。
　　英文注释模版：
　　/**
　　* CopyRright (c)2008-xxxx:   <展望软件Forsoft >
　　* Project:                     <项目工程名 >
　　* Module ID:   <(模块)类编号，可以引用系统设计中的类编号>
　　* Comments:  <对此类的描述，可以引用系统设计中的描述>
　　* JDK version used:      <JDK1.6>
　　* Namespace:           <命名空间>
　　* Author：        <作者中文名或拼音缩写>
　　* Create Date：  <创建日期，格式:YYYY-MM-DD>
　　* Modified By：   <修改人中文名或拼音缩写>
　　* Modified Date:  <修改日期，格式:YYYY-MM-DD>
　　* Why & What is modified  <修改原因描述>
　　* Version:                  <版本号>
　　*/
　　如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：
　　//Rewriter
　　//Rewrite Date：<修改日期:格式YYYY-MM-DD> Start1：
　　/* 原代码内容*/
　　//End1：
　　将原代码内容注释掉，然后添加新代码使用以下注释：
　　//Added by
　　//Add date：<添加日期，格式：YYYY-MM-DD> Start2：
　　//End2：
　　如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下
　　注释：
　　//Log ID：<Log编号,从1开始一次增加>
　　//Depiction：<对此修改的描述>
　　//Writer：修改者中文名
　　//Rewrite Date：<模块修改日期，格式：YYYY-MM-DD>
　　2、接口注释：
　　接口注释采用 /** …… */，在满足类注释的基础之上，接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用，块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。

　　考试大温馨提示：本内容来源于网络，仅代表作者个人观点，与本站立场无关，仅供您学习交流使用。其中可能有部分文章经过多次转载而造成文章内容缺失、错误或文章作者不详等问题，请您谅解。如有侵犯您的权利，请联系我们，本站会立即予以处理。

上一页1234下一页