包的注释内容-引用

引用说明:原文来自于http://topic.csdn.net/u/20101230/19/11839179-6dda-43a0-9bbf-c8d753908a13.html ,为了方便本人阅读,文本格式略有调整。

今天刚好看了**公司的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>

猜你喜欢

转载自cnmqw.iteye.com/blog/894042