Java自动生成注释代码
在学习Java过程中,要养成良好的编写注释文档的习惯,加入企业后也会被要求写注释文档,学习自动生成注释的代码至关重要,这里以eclipse编译器为例。
在窗口Windows下找到Preferences->Java->Code Style->Code Templates
里面有两个目录 Comments和Code,如下图所示:
![Comments是注释代码模板,Code是代码模板](https://i-blog.csdnimg.cn/blog_migrate/5376e5b09645b1002c9787b5854f9841.png#pic_center)
Comments是注释代码模板,Code是代码模板
我们先来看Comments
Comments for Files是Java文件注释,位于新创建类的最上方,模板如下:
/**
*文件名:${file_name}(会自动生成你创建的文件名)
*做什么:${todo}(这里可以用一句话说明这个文件用来做什么)
*创建年份:${year}
*创建日期:${date}
*创建时间:${time}(自动生成被创建的时间)
*${git_config}(表示空格)
*工程名:${project_name}
*包名 :${package_name}
*类名:${type_name}
*使用者:${user}
*以上内容可选
*/
实际生成样式如下图:
Comments for Types是Java类注释,位于新创建类的上方,模板如下:
/**
* @author 作者 E-mail:gaoyu 1627509468@qq.com
* @date 创建时间:2020年4月7日 下午12:27:45
* @version 1.0
* @parameter
* @since
* @return
*/
如下图展示:
Comments for Fields是Java类字段注释
/**
* ${field}:${todo}(用一句话描述这个变量表示什么).
*/
Comments for Constructors是创建构造函数时上方的注释
/**
*Create a new constructor
*${tags}
*/
Comments for Methods是Java方法注释
/**
*${enclosing_method}
*${return_type}
*/
Comments for overriding methods是方法重写注释
/**
*${todo}
*${see_to_overridden}
*${enclosing_type}
*/
Comment for delegate methods是代理方法注释
/**
* ${tags}
* ${see_to_target}
*/
Comment->Getters是Java Getters方法注释
/**
** @return ${bare_field_name}
*/
Comment->Setters是Java Setters方法注释
/**
* @param ${param} ${bare_field_name} to set
*/
Comment->Modules
/**
* @author ${user}
*
* ${tags}
*/
若想要实现新建类时自动生成注释,则将勾选框:Automatically add comments for new methods,types,modules,packages and files 选中即可。
下面是Code代码段:
Method body
// ${todo} Auto-generated method stub
${body_statement}
Constructor body
${body_statement}
// ${todo} Auto-generated constructor stub
Getters body
return ${field};
Setters body
${field}=${param};
Catch block body
// ${todo} Auto-generated catch block
${exception_var}.printStackTrace();
一般情况下,Class body和Interface body下建议为空。
以上仅为个人观点,可选择使用,养成良好的编码习惯,这样使用公司统一标准时会更加顺手,开发人员可以接受。