网上检索了java代码给类添加注释说明的方法和规范,均千篇一律的显示作者、说明、版本、时间等,但本人实例操作中发现@description在IDE中出现警告,打开IDE注释中的变量发现没有此项,又打开JDK的源文件寻找注释方法后,发现用IDE注释不够规范,也不够漂亮。
工具/原料
1
JDK自带的类文件
2
eclipse
官方注释方法
1
类html标签实现的,可以对解释文本的特殊处理,比如加重、换行、段落等。
2
固定标签author、beaninfo、see等。END
IDE注释方法
1
新建类时候自动生成类注释标签,需提前配置。windown-preferences->java-code style->code templetes->comments-types.
2
给已有类添加类注释说明。在类上方依次键入/**回车,添加注释说明,如果IDE已经配置模板,则会按照模板添加注释说明模板。END
混合用法助力规范优雅注释说明
1
根据上面的介绍配置IDE的类添加注释说明模板,具体在comments->type里配置。
2
在生成的类注释说明模板里修改相关项,并添加类html修饰说明部分。
注意事项
没有所谓的规范和标准,参照官方实例即可。
上一篇:CSS样式命名规则
下一篇:java编码要注意10个细节问题