Myeclipse Java 代码注释工具
1.作用:统一项目开发人员的编码风格,利用维护。
2.预定义codetemplates.xml文件。(常用的编码注释规范模板)
3.将模板导入到Myeclipse:MyeclipsewindowPreferencejavacode style code templateimport
4.导入后成果:Comments代表注释模板,Code代表代码模板,其中每一个子菜单代表子项的模板。我们只要点击某一个子项,就会在界面下方的Pattern区域看到该项我们所定义的模板内容和格式,如下图所示:
Comments
Files(Java文件注释) 新建文件时自动加载
Types(Java类注释) 新建文件时自动加载
Fields(类字段注释) alt+shift+s generate Constructors and Fields
Constructors(构造函数注释)alt+shift+s generate Constructors and Fields
Methods(Java方法注释)alt+shift+j or alt+shift generate element comment
Overriding methods(重写方法注释) alt+shift+s Overriding methods
Delegate methods(代理方法注释)alt+shift+s generate Delegate methods
Getters(Java Getter方法注释) alt+shift+s generate getters and setters
Setters(Java Setters方法注释)alt+shift+s generate getters and setters
CheckStyle插件安装与使用
1.作用:CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程。
2.内容:CheckStyle检验的主要内容包括Javadoc注释、命名约定、标题、Import语句、体积大小、空白、修饰符、块、代码问题、类设计、混合检查。
3.下载插件并安装:
MyEclipse的插件下载地址将下载文件放入myeclipse安装目录中dropins文件下。如下图所示。重启软件即安装完成。
4.Checkstyle大体设置:
5.应用:打开我们的代码,如果代码中有不符合Checkstyle定义的规范的地方,Eclipse会黄色高亮显示,如下图所示:
如果我们把鼠标悬停在高亮代码上,Eclipse会给出提示警告信息。
6.google java style 中文版 :下载地址
Myeclipse JS 代码注释工具
类比第一章的方法,设置菜单如下图
这篇博文是我当前团队里一个90后整理的,很开心看到现在的90后们在团队内贡献更多。