首先,咱得有自己整洁的注释风格。
强调开发规范的公司,肯定会强调代码的规范注释,自学过程中,有自己的通用注释模板就很重要了,养成良好的习惯,以后再根据公司的要求作出具体的要求。
这东西,简单,配置一次就行了,提醒我自己把,有个规范意识。
1. 修改新建类自动创建的通用个人模板
修改位置:
导航栏找到 window -> preference ->java->Code Style -> Code Template -> Code->New java files->edit
修改为以下模板:
${filecomment}
${package_declaration}
/**
*注释
*@author ${user} (le_lee@foxmail.com) <br>
* @date ${date}
*/
${typecomment}
${type_declaration}
// 解释:前两行二行是自动填入所在位置的包名
// 最后两行是自动生成类的声明格式
2. 类名或者方法名上方的注释
- 类名上注释模板
修改位置:
导航栏找到 window -> preference -> java ->Code Style ->
Code Template -> Comments ->Types ->edit
修改为以下模板:
/** 注释
* @author ${user} (le_lee@foxmail.com) <br>
* @date ${date}
* ${tags}
*/
- 方法上注释模板:
修改位置:
导航栏找到 window -> preference -> java ->Code Style ->
Code Template -> Comments ->Methods ->edit
修改为以下模板:
/** 方法注释
* @author ${user} (le_lee@foxmail.com) <br>
* @date ${date} ${time}
* ${tags}
*/
写没写
tag,悬停提示还是有参数和返回值的区别,就是没写
{tag}的不会在编辑面板自动补充其他的参数信息。
修改好注释的快捷填充模板以后,还可以导出(export)为xml文件,
下次你用新的基于Eclipse的插件,或者换了个新的,直接导入,不用再那么麻烦的修改啦
user默认情况下,就是你的电脑的administor的名字。我用的是window,我就不知道Mac什么情况了。
修改注释中${user}的名字
在Eclipse.ini文件中,增加-Duser.name=作者名。以拼音为例子,增加-Duser.name=lile
重启Eclipse后,测试下是否已经换成了新的。
自己写的还只是自己用到的,写博客经验也不多,没那么全,给一个比较好的注释的学习链接吧: Eclipse注释模板设置详解