如何在eclipse 中设置自动添加Javadoc注释

2024-11-28 19:37:52
推荐回答(2个)
回答(1):

方法一:Eclipse中设置在创建新类时自动生成注释 


windows-->preference 
Java-->Code Style-->Code Templates 
code-->new Java files 
编辑它 

${filecomment} 
${package_declaration} 
/** 
* @author 作者 E-mail: 
* @version 创建时间:${date} ${time} 
* 类说明 
*/ 
${typecomment} 
${type_declaration} 

方法二:

通过菜单 Window->Preference 打开参数设置面板,然后选择:
Java -> Code Style -> Code     Templates


在右侧选择Comments,将其中的Files项,然后选右边的"Edit",进入编辑模式:   


进入编辑模式后就可以自定义注释了。另外可以插入一些变量,如年、日期等等。


最后,确保 Code -> New Java files 中有:"${filecomment}"


当然,通过“导出”和“导入”功能,你可以把自己的模板导出来在其他机器上使用。



    以上是文件注释,类中的方法自动添加注释类似,对应于Files下面的Types。

 

Eclipse快捷键:选中你的方法后alt+shift+J

回答(2):

如果你是自己写代码而不是开发 Eclipse 插件之类的工具的话, 还是手工写吧,自动添加的跟没添加没有什么不同。 文档应该写得有意义,实践证明自动添加的用眼睛看起来几乎是多余的。 在每个要加注释的方法或类的前面写上 /** 开头和 */ 结尾的就是 javadoc 类型的注释了,之后在菜单上 Project > generate JavaDocs 生成网页吧。