现在的位置: 首页 > 综合 > 正文

为javadoc文档的包生成注释

2013年06月04日 ⁄ 综合 ⁄ 共 273字 ⁄ 字号 评论关闭

要生成包注释文件,您必须将其命名为 package.html并且放在源代码树中的包目录下,和 .java 文件在一起。Javadoc 将自动寻找该位置中的此文件名。注意该文件名等同于所有包。

 

包注释文件的内容是用 HTML 写的大文档注释,像其他所有注释一样,有一个 例外:文档注释中不应该包含注释分隔符 /** 或 */ 或主要的星号

 

在书写注释时,您应该在第一句中写上该包的摘要,而不是写上标题或其他文本。您可以包含包标签,如同所有文档注释一样,所有的标签,除了 {@link} ,都必须出现在描述之后。如果您在包注释文件中添加 @see 标签,那么它必须有全限定名。

抱歉!评论已关闭.