您的位置：首页 > 编程语言 > Java开发

如何给"包"添加Javadoc注释

2013-11-14 13:22 309 查看
今天刚好看了**公司的ava编程规范，也是建一个package.html放在当前目录下。

3. 包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。

说明：在详细描述中应该说明这个包的作用以及在整个项目中的位置。

格式：

<html>

<body>

<p>一句话简述。

<p>详细描述。

<p>产品模块名称和版本

<br>公司版权信息

</body>

</html>

示例：

<html>

<body>

<P>为 WEBSMAP 提供通信类，上层业务使用本包的通信类与 SMP-B 进行通信。

<p>详细描述。。。。。。。。

<p>IIN V100R001 WEBSMAP

<br>(C) 版权所有 2000-2001 华为技术有限公司

</body>

</html>

另外还有种方法：

另类的package-info.java文件探讨

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 点击这里给我发消息
标签： 
相关文章推荐
新的分享
章节导航