java注釋（類、構造函數、方法、代碼塊、單行、屬性注釋）

1、類注釋(Class)

類注釋(Class)主要用來聲明該類用來做什么，以及創建者、創建日期版本、包名等一些信息:

/**
 * @version: V1.0
 * @author: XXXX
 * @className: Student
 * @packageName: xxxxx
 * @description: 這是學生信息類
 * @data: 2017-07-28 12:20
 **/

2、構造函數注釋(Constructor)

構造函數注釋(Constructor)主要用來聲明該類的構造函數、入參等信息:

**
* @description: 構造函數
* @param: [sid, pid]
*/  

3、方法注釋(Methods)

方法注釋(Methods)主要用來聲明該類的作用、入參、返回值、異常等信息:

 /**
 * @author:  XXXX
 * @methodsName: saveInfo
 * @description: 保存信息
 * @param:  xxxx
 * @return: String
 * @throws: 
 */

4、代碼塊注釋(Block)

    /**
     * 實例化一個用戶
     * xxxxxxx
     */
    User user=new User();

5、單句注釋

//實例化一個用戶
Student stu=new Student ();  

6、字段名注釋

    /**
     * 用戶名
     */
    public String name;