在Eclipse中自动添加注释和自定义注释风格的方法:
1、Eclipse菜单栏上选择 Window -> Preferences -> Checkstyle,进入如下设置界面:
2、在Global Check Configurations框中,列出可以选择的检查配置(Check Configuration),Default栏标记为对勾的默认配置。
如果想自己配置检查选择,可以点击“New...”按钮新建一个配置,进入如下Check Configuration界面:
3、检查配置的类型,可以有多种选择。Internal Configuration类型是检查配置存在于Eclipse内部;External Configuration类型相当于导入一个已有的xml配置文件。Checkstyle配置都是xml文件。
下面这段代码经过Checkstyle检查之后,不符合规范的代码,底色都会被标记为浅黄色进行提示。点击行头的提示标记,就会显示具体不符合规范的地方。示例如下图所示:
分两种情况的:
如果是javadoc的注释:可以通过 alt+shift+ j
如果是 lisence:可以同个 code template实现
自定义注释风格
Window->Preference 打开参数设置面板,然后选择:Java -> Code Style -> CodeTemplates
可以看到Comments下面一系列可以注释的Java代码组成部分(对文件、变量、方法、构造方法、重载函数等等),比如我想定制Java文件的注释风格,那么在右侧选择Comments中的File项,点击Edit,进入编辑模式,这样就可以自定义注释了。其中可以插入一些变量,如日期、文件名、作者等等。