Eclipse使用自动注释:在Eclipse工具的Window\preferences\JAVA\Code Style\Code templates\Comments下设置以下模版
文件(Files)注释标签
/** * @Title: ${file_name} * @Package: ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author: ${user} * @date: ${date} ${time} * @最后修改人: ${user} * @最后修改时间: ${date} ${time} * @version: V1.0 * @copyright: ASIAINFO */
特别说明:关于“${user}”配置,如果想配置成自己自定义的姓名,如:张三,则需要在eclipse/myeclipse的目录下找到eclipse.ini/myeclipse.ini文件,在-vmargs后边添加上启动参数:-Duser.name=张三,并重启myeclipse工具后“* @author ${user}”将改变为“* @author 张三”。
类型(Types)注释标签(类的注释)
/** * @ClassName: ${type_name} * @Description: ${todo}(这里用一句话描述这个类的作用) * @author: ${user} * @date: ${date} ${time} * @最后修改人: ${user} * @最后修改时间: ${date} ${time} * ${tags} */
字段(Fields)注释标签
/** * @Description: ${todo}(这里用一句话描述这个类的作用) * @Fields: ${field} */
构造函数标签
/** * @Title: 构造函数 * @Description: (描述构造函数实现的功能) * ${tags} */
方法(Constructor & Methods)标签
/** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * @最后修改人: ${user} * @最后修改时间: ${date} ${time} * ${tags} 对方法的参数进行描述 * @return: ${return_type} 返回类型 * @throws */
覆盖方法(Overriding Methods)标签
/** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * @最后修改人: ${user} * @最后修改时间: ${date} ${time} * ${see_to_overridden} * ${tags} 对方法的参数进行描述 * @throws */
代理方法(Delegate Methods)标签
/** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * @最后修改人: ${user} * @最后修改时间: ${date} ${time} * ${see_to_target} * ${tags} 对方法的参数进行描述 * @throws */
getter方法标签
/** * @Title: 返回 ${bare_field_name} 的值 * @return ${bare_field_name} */
setter方法标签
/** * @Title: 设置 ${bare_field_name} 的值 * @param ${param} 参数设置变量 ${bare_field_name} 的值 */
设置完成之后,可以输入/**然后回车就可以自动添加注释了。
时间: 2024-12-29 12:58:42