4.9.6 包与概述注释
可以直接将类、方法和变量的注释放置在Java源文件中,只要用/** . . . */文档注释界定就可以了。但是,要想产生包注释,就需要在每一个包目录中添加一个单独的文件。可以有如下两个选择:
1)提供一个以package.html命名的HTML文件。在标记
...之间的所有文本都会被抽取出来。
2)提供一个以package-info.java命名的Java文件。这个文件必须包含一个初始的以/**和*/界定的Javadoc注释,跟随在一个包语句之后。它不应该包含更多的代码或注释。
还可以为所有的源文件提供一个概述性的注释。这个注释将被放置在一个名为overview.html的文件中,这个文件位于包含所有源文件的父目录中。标记
... 之间的所有文本将被抽取出来。当用户从导航栏中选择“Overview”时,就会显示出这些注释内容。【责任编辑:
夏书 TEL:(010)68476606】