Javadoc:文档注释常用参数
常见注释类型 | 注释含义 |
---|---|
@author | 类的作者 |
@version | 类的版本 |
@param | 方法的参数 |
@return | 方法的返回类型 |
@exception | 方法抛出的异常 |
@see | 另外参照…… |
@since | 从什么时候开始使用的 |
@date | 日期 |
@time | 时间 |
最常用设置对象
类型(Types)注释标签(类的注释)
方法(Methods)标签:(接口和其实现类的方法,都要加注释)
Eclipse设置步骤
在这里选择目标类型,定制自己的个性化注释即可,设置好以后选择类名、方法名、字段名加上快捷键Alt + Shift + J,即可生成个性化注释。
【效果】在设置完以后,在new对象或者调用方法时,只要将鼠标悬浮于该类或者方法名称上,就能看到文档注释的具体描述,更加方便观察其功能。
IDEA设置步骤
IDEA比较细致,但是也是比较繁琐,主要关注配置的位置,设置都是类似的。
配置类的注释
位置:File–>Settings–>Editor–>File and Code Templates–>Files
在这里配置好以后创建类的时候会直接创建注释,这里相对Eclipse要方便一些。
配置方法的注释
这个配置暂时不讲了,它的配置步骤繁琐,最根本的原因是不实用,原则上和字段的文档注释一样,使用“/** + Enter”直接自定义写注释即可。
标签:配置,eclipse,IDEA,注释,文档,设置,方法 From: https://www.cnblogs.com/gengyp/p/18108115