Java-三种注释的用法

2019独角兽企业重金招聘Python工程师标准>>>

一、单行注释

以“//”开头，后面接要说明的内容。使用范围没有什么规定，比如开发前，我们可以用单行注释把思路写下来，开发后，可以把局部说明写下来供后人参考。

比如我们一般在实体类的属性后面用单行注释注明（如下）：

public class User implements Serializable{

   private String id;// 自增型ID

   private String username;// 用户名

   private String password;// 用户密码

}

 

善用标记编码时更轻松，使用 TODO 和 FIXME 可以在 Eclipse 编码框右侧显示蓝色标记

// TODO ... 表示此处有功能需要编写

// FIXME ... 表示此处代码需要修正

 

二、多行注释

又称为块注释，可以把一部分代码块注释掉，使用范围不太清楚，但是我一般都拿来注释代码。

比如我们要注释一个判断的一部分，用多行注释就很方便（如下）：

if (null != password /* && password.trim() != "" */) {
    return "ok";
}

 

三、文档注释

文档注释用得比较少，但是很方便，尤其是他自带的那些标签，我个人的建议是加在认为有必要加注释的方法、类、接口、全局变量等上面，因为在Eclipse中把鼠标移动到方法上，会显示出写了文档注释的说明，很实用（如下）：

 

1. 文档注释标签语法

下图转自：http://c.biancheng.net/cpp/html/1761.html

 

 

 

 

 

 

 

 

 

 

 

 

 

 

2. 嵌入式HTML标签

作用是对复杂的文档注释进行格式化，我在看某些官方文档的时候发现的，可以让文档注释更容易读懂，就像我上面图里的，就是用了嵌入式HTML标签，不然文档显示出来时早就挤在一起了，非常难读懂（如下）：

/**
 * <p>session状态</p>
 * 
 * <pre>
 * key="sessionDestroyedStatus"(session销毁时的状态): 
 * value="busy": 异地登陆; 
 * value="timeout": 超时自动销毁; 
 * value="logout": 手动退出
 * <pre>
 */
public static Map<String, String> sessionStatusMap = new HashMap<String, String>();

这个我找得不全，我就说一下我用过的几种，总体的用法都是和HTML差不多的：

<p></p>                                    定义段落

<pre></pre>                             定义预格式化的文本

<code></code>                        暗示着这段文本是源程序代码

<i></i>                                      鼠标悬浮上方显示斜体文本效果，与<em></em>显示效果类似

<br>                                           换行

<em></em>                             表示为强调的内容，把这段文字用斜体来显示

<blockquote></blockquote>   标记长的引用，在 blockquote 元素前后添加了换行，并增加了外边距

<h1></h1>                               <h1>~<h6>，都显示加粗，不会变大

<strong></strong>                   加粗

<ul></ul>                                  配合<li></li>使用，和HTML一样，很方便

加红的显示效果和普通的迥异，个人认为平时使用足矣。

 

转载于:https://my.oschina.net/NamiZone/blog/870773