注释规范
- 格式：pdf
- 大小：342.86 KB
- 文档页数：7
ActionForm form, HttpServletRequest request,
HttpServletResponse response) {
……………
｝
四、代码内的注释 1、单独行注释：在代码中单起一行注释， 注释前面空一行，并与
其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注 释。
/** * @todo 注释内容 */
注释规范
注释采用javadoc的注释方法，所有注释放置于所注释目标的上方。 一、类或接口的头注释 /********************************************************** * 类描述信息 * @author 作者信息 * @date 创建日期 * @time 创建时间 * @FileName 文件名字 * @version 类或接口模块的版本号 **********************************************************/
二、属性的注释 格式:
/** * 注释内容 */
…代码(属性)… 生成快捷方法(Myeclipse)：在属性上一行先用键盘打出“/**”再按回
车键即可。
三、方法的头注释
格式:
/**
*方法描述信息
* @param
* @return
* @throws
*/
…代码(方法)…
如：
/**
* 获取新闻的详细信息
格式： /* 注释内容 */ 或 //……注释内容（推存用后者）
2、行头注释：在代码行的开头进行注释,注释前面空一行。主要为 了使该行代码失去意义。
格式： // 注释内容
3、行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进 行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。
* @param nID
*
对应新闻的id
* @return
*
新闻详细信息
*/
SztzXxglXwsx getNewsDetail(int nID);
注意：其中对参数的中文说明统一写在英文参数下面。
生成快捷方法(Myeclipse)：在方法上一行先用键盘打出“/**”再按回
车键即可。
在对方法进行描述的时候，要用精简的语言对整个方法流程概述，
*
* <br/><br/>
*
* 访问地址：/module/alarm/listBDZTree.do?cityID=**<br/>
* 参数：<br/>
*
cityID:地市对应的ID信息
*
* @param mapping <br/>
*
success：/module/alarm/left.jsp 显示树状信
格式： 代码 + 8（至少4）个空格 + // 注释内容
4、块注释： 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途 的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起 到引导的作用，也可以根据需要放在合适的位置。注释前面至少空一 行。 格式：
/* * 注释内容 。
注意：在action中，因为方法关系到页面跳转和业务逻辑，注释要求更
为详细清晰。
格式如下：
举例：方法listBDZTree的注释
/**
* 根据地市显示变电站树信息<br/>
* <br/><br/>
* 根据变电站ID信息，从系统缓存中获取对应的地市变电站<br/>
* 并将其以树的形式进行展示
息
* @param form <br/>
*
简单参数，无对应的ActionForm信息<br/>
*
参数cityID：地市对应的数据库ID信息
* @param request
* @param response
* @return
*/
@SuppressWarnings("unchecked")
public ActionForward listBDZTree(ActionMapping mapping,
类或接口的头注释每次在生成类或接口时可以自动生成，过程如 下： （1）、先定义头注释格式
打开MyEclipse，选择“Window”->“Preference...”->再展开找 到“Code Templates” 如下：
(2)、自动生成类或接口的头注释
(3)、如果在新建的类或接口文件最上面有三行注释,那是文件注释，要 去掉文件注释方法如（1），在“Comments”中双击“Files”进行编 辑，并设置为空即可。
