在无论什么项目中,注释都是不可缺少的,注释的种类和风格非常之多,每个公司有每个公司自己的一套标准,中大型项目一般写注释是为了自动生成文档便于维护,比如Java自带的Javadoc、功能更强大使用更广泛的Doxygen(Doxygen自动文档生成工具在Eclipse中的集成及使用举例)等。注释的任务其实挺繁重的,总以为自己在做着无意义的事,每次重复的写着统一的注释风格更是费时费力。Eclipse用的很熟的都知道Eclipse里自带了某些注释风格,但并不一定适用于你的标准,因此如何自定义注释风格然后自动添加就显得非常有意义了,让我们省时省力。


目录

1. 如何自动添加注释

2. 如何自定义注释风格

3. 导入/导出代码格式模板


1. 如何自动添加注释

可通过如下三种方法自动添加注释:

(1)输入“/**”并回车。

(2)用快捷键 Alt+Shift+J(先选中某个方法、类名或变量名)。

(3)在右键菜单中选择“Source > Generate ElementComment”。

 

2. 如何自定义注释风格

自带的注释格式你不一定喜欢或不符合你公司的标准,那么可以通过下面方法进行修改。

(1)Window->Preference 打开参数设置面板,然后选择:Java -> Code Style -> CodeTemplates

javaHSFSheet添加注释 java怎么添加注释_javaHSFSheet添加注释

可以看到Comments下面一系列可以注释的Java代码组成部分(对文件、变量、方法、构造方法、重载函数等等),比如我想定制Java文件的注释风格,那么在右侧选择Comments中的File项,点击Edit,进入编辑模式,这样就可以自定义注释了。其中可以插入一些变量,如日期、文件名、作者等等。

javaHSFSheet添加注释 java怎么添加注释_自定义_02


 

3. 导入/导出代码格式模板

如果你辛辛苦苦定制好了自己的代码风格,然后换了台机器进行操作或重装了Eclipse,是不是要重新配置一遍呢?答案当然是No了,Eclipse提供了“导出”和“导入”功能,你可以把自己的模板导出来在其他机器上使用。

javaHSFSheet添加注释 java怎么添加注释_自定义_03