看了一些代码,经常背地里骂他们不写注释(其实我也不怎么写),前段时间看了另外一些工程的代码,注释不多,但已经好多了,而且感觉挺规范的(该有注释的地方有,而且用了一些javadoc),所以自己决定,以后也要写些注释并且要加上javadoc的注解,学习………………,下面是我用的一些注解和部分理解,与java规范无关,主要是我的习惯,仅供参考,也欢迎大家批评指正。
1. @author
这个好理解,作者信息,这个可以用多个@author
例:/**
*
* @author test
* @author test2@gmail.com
* @Date 2011-12-19
* @version 1.0
*/
2.@Date
日期
3. @version
版本,每个类或接口最多有一个
4.@since
功能模块从啥时候开始有的
5.{@link }
链接相关的类或者方法,我觉得主要是这个类或者方法中调用的
6.@see
参考的其他类或者方法,这个类的相关类或者父类、子类什么的,会出现在doc中的参见项中。例:DateFormat 的注解。
* @see Format
* @see NumberFormat
* @see SimpleDateFormat
* @see java.util.Calendar
* @see java.util.GregorianCalendar
* @see java.util.TimeZone
public abstract class DateFormat extends Format
7. {@value}
用来显示静态字段的值。例:
/**
* The value of this constant is {@value}
**/
public static final String SCRIPT_START = "script";
鼠标移动到SCRIPT_START 上面后出现:
The value of this constant is "script"
8.
分享到:
相关推荐
javadoc插件使用文档
idea easy_javadoc插件
Java 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、...
javadoc使用指南
redis-service 的JavaDoc
JMS API JAVADOC,详细解释方法的使用。
如何用Eclipse创建javadoc,向您介绍如何使用eclipse自动生成doc
使用Javadoc生成Java API文档的方法
使用Eclipse生成javadoc文档的方法
list和index.html文件,不需要作任可加工,解压直接可以使用,到处下载,转码反编译,拆腾了一天,终于搞好了,希望只用你一分钟,本来想免积分分享,但是系统不允许,如果你能用,别忘了给五星。
不过在运行过程中,它也使用了Java平台的环境变量classpath来确定类查找路径。这样当涉及类和内部类的有关描述时,是否正确地设置了classpath变量可能会影响到javadoc命令是否可以完全成功执行。
答:我写文章的时候是用的 JDK 1.3 的 javadoc,可能 JDK 1.4 的 javadoc 不支持中文吧…… 事实上,我根本没能正确的解答这个问题。后经过对 JDK 1.3 和 JDK1.4 的分析,终于找到了正确答案:JDK 1.4 的资源包...
Myeclipse导出Javadoc步骤
JavaDoc写法规范 JavaDoc写法规范 JavaDoc写法规范
中文JAVADOC中文JAVADOC
注释规范(javadoc)
Eclipse中自动生成Javadoc的方法,以及一些标签的含义
rabbitmq-javadoc rabbitmq-javadoc html
1、Javadoc2chm工具
javadocjavadoc