【转】Java注释规范（Java注释中的Html标识）

原文地址：http://my.oschina.net/yafey/blog/117043

 

今天先列一个提纲，待有时间了再来补充。2013年3月25日0:02:18

1. 背景
2. 意义
3. 注释的原则
4. Java注释方法、格式、原则及技巧（概要：一些方法、eclipse模板文件的制作）
5. 细枝末节（不想去碰到，碰到被搞死的情况）

• 五、细枝末节 （转自网络）关键字 ：注释、标签、<

         有时候我们需要在注释中写 html 标记或者 xml 节点标记（显示html标记，例如：要显示<href>），但是直接在注释中的话，查看时我们的<xxx>标签会被过滤掉，如下，假设我们要在注释中写<height>185</height>如果直接这样写的话，查看时将只有 height 的值，要想达到预期的目的，需要这样写：&lt;height>185&lt;/height>
即：将 < 替换为 &lt; 即可