设为首页 加入收藏

TOP

4.9.6 包与概述注释
2013-10-07 00:29:04 来源: 作者: 【 】 浏览:59
Tags:4.9.6 包与 概述 注释

4.9.6   包与概述注释

可以直接将类、方法和变量的注释放置在Java源文件中,只要用/** . . . */文档注释界定就可以了。但是,要想产生包注释,就需要在每一个包目录中添加一个单独的文件。可以有如下两个选择:

1)提供一个以package.html命名的HTML文件。在标记...之间的所有文本都会被抽取出来。

2)提供一个以package-info.java命名的Java文件。这个文件必须包含一个初始的以/**和*/界定的Javadoc注释,跟随在一个包语句之后。它不应该包含更多的代码或注释。

还可以为所有的源文件提供一个概述性的注释。这个注释将被放置在一个名为overview.html的文件中,这个文件位于包含所有源文件的父目录中。标记... 之间的所有文本将被抽取出来。当用户从导航栏中选择“Overview”时,就会显示出这些注释内容。

【责任编辑:夏书 TEL:(010)68476606】

回书目   上一节   下一节

】【打印繁体】【投稿】【收藏】 【推荐】【举报】【评论】 【关闭】 【返回顶部
分享到: 
上一篇4.9.2 类注释 下一篇4.10 类设计技巧

评论

帐  号: 密码: (新用户注册)
验 证 码:
表  情:
内  容: