一、可以用注释来调试程序。
二、单行注释<//注释内容>,不能跨行。
三、多行注释</*注释内容*/>,可以跨行
四、文档注释确保了注释与源码的连接,便于维护,格式</**注释内容*/>>,不同于单行和多行注释放在要注释语句的后面,文档注释必须放在要注释的语句前面,且文档注释默认只处理public和protected修饰的类、接口及方法,如果要处理privated修饰的,需要在javadoc中命令汇总增加“- privated”命令
(一)将文档注释转为API文档,用javadoc命令,格式:“javadoc <命令选项> java源文件(或包文件名)”,源文件或包支持通配符,支持多个包一起写。
(二)常用命令选项包括:
1、-d <指定生产路径>
2、-windowtitle <浏览器窗口标题>
3、-doctitle <概述页面标题> 注意:只有多个包下的源文件生成的API才有概述页面
4、-header <包含所有页面的页面标题>
(三)文档注释中可以用javadoc标记(标记放在/**和*/之间即可),常用标记如下:
1、@author 标注作者
2、@version 标注版本
3、@deprecated 不推荐的使用的类或方法,给出取代该方法或类的建议
4、@see 参见,可以用带链接的<>标签,也可以直接跟方法或变量路径,但是类名与方法名(变量名)直接用#号,而不是.号,包名与类名仍然用.号。
5、@throws 抛出异常
6、@exception 抛出异常
7、@param 方法参数说明 注:同一个方法多个参数说明必须放一起
8、@return 方法返回值说明
注意:@param、@return、@throws、@exception只能用于标记方法;同时生成的文档默认不含@author和@vertion属性,若有必要,需在javadoc语句汇总增加“- author -version”命令。
五、包注释。包注释不是直接放在java源码中的,但也要通过javadoc生成在API中,包文件通过标准的HTML文件提供,注释内容位于该文件中的<body>标签中,该文件需命名为package.html,并与该包下的所有源文件放在一起。
运行时用“javadoc <命令选项> 包文件名”即可。
六、其他
(一)注释内容可以使用HTML修饰符,但不要使用<h1>或<hr>等标题标签,否则会产生冲突,因为javadoc会产生自己的标题。
(二)类的文档注释需在import语句之后。