Java 程序员如何写注释

1. 首先设置 ADT／Eclipse -> Perference -> Java -> Code Style -> Code Templates , 自定义自己想要的注释模版。

2. 也可以手动敲注释，一般Java 基本上只需要知道五个基本标识:

    /** 
     * <p>The extra key of intent.</p>
     * <p>Use this key to obtain the <code>int</code> bitmap mask {@link Intent#getIntExtra(String name)},
     * corresponding to the List of {@link #parserDomainIP(byte[])}.</p>
     * <p>It indicates which domain name is hijacking by DNS server.</p>
     * <b>1</b>: hijacking, unsecure <p>
     * <b>0</b>: non-hijacking, secure
     * @see #doRoot
     */ 
    public int getRootHistory() {
         ......
    }  

<p></p>: 表示一整段文字的描述，没有换行

<b></b>: 表示文字用粗黑体

{@link Class#Method}: 表示蓝色高亮显示，而且点击可以跳转到对应Class#Method

{@link #Method}: 表示蓝色高亮显示，而且点击可以跳转到当前Class 的 Method

<code></code>: 表示文字用代码的字体表示出来，没有高亮，但是字体跟普通注释不一样 

{@see Class#Method}: 注释会自动添加“See Also xxxxx” 后面的Class#Method 也会高亮显示并且自动链接跳转

Note : '#' 一般表示 '.' ，例如 Intent.getIntExtra(String name), 用注释文字写成 Intent#getIntExtra(String name)