java注释
- 单行注释 由//开始，一直到本行结束
- 多行注释 由/*开始，到*/结束 注意：不能嵌套使用
- 文档注释 由/**开始，到*/结束
|
1
2
3
4
5
|
/*** This is a java progamming.* @author wwf* @version 1.2*/ |
javadoc的生成命令
javadoc -d doc HelloWorld.java//指定以doc为文件夹名
javadoc [option] [packagenames] [sourcefiles] [@files]
文档注释位置
- 类注释：import语句之后，class或interface之前。用于说明整个类或接口的功能和特性
- 方法注释：方法之前，仅靠方法。用于说明定义方法
- 属性注释：默认情况下，javadoc只对公有（public）属性和受保护属性（protected）产生文档--通常是静态常量
- 包注释：类、方法、属性的注释都直接放到java的源文件中，而对于包的注释，无法放到java文件中去，只能在包对应的目录中添加一个package.html的文件来达到这个目的。
- 概要注释：overview.html 和包一样无法直接从java源文件中提取，生成html文档时<body></body>之间的内容都会被提取。
java常用标记
@author
@version
@docroot：产生文档的根路径
@param：方法的参数类型
@return：方法的返回类型
@see：“参见”，用于指定参考的内容
@exception:抛出异常
@throws：抛出异常
