转自:https://blog.csdn.net/suyu_yuan/article/details/50898380
为什么要用Javadoc注释
本人目前还没有工作,网上说以后到企业写代码都要用这样的注释,这样对同事和自己都方便,所以不放我们现在就开始养成这个习惯吧!
给java文件添加注解
在eclipse中找到Window => Preferences => 输入javadoc => code => new Java file => Edit
输入:
${filecomment}${package_declaration}
/**
* @author : suyuyuan
* @date 创建时间:${date} ${time}
* @version 1.0
* @parameter
* @since
* @return
*/
${typecomment}${type_declaration}
Apply and Close 完工!
给java类中的方法添加注释
在eclipse中找到Window => Preferences => 输入javadoc => Comments => Methods => Edit
输入 :
/**
*
*
* ${tags} ${return_type}
*/
Apply and Close 即可!
想要添加注释,按下组合快捷键:Alt+Shift+J。
以下是一个大神写的比较全面的注释方法及javadoc注释模板,大家可以参考。
http://www.cnblogs.com/fsjohnhuang/p/3988883.html