1、單行(single-line)--短註釋://……
單獨行註釋:在代碼中單起一行註釋, 註釋前最好有一行空行,並與其後的代碼具有一樣的縮進層級。如果單行無法完成,則應採用塊註釋。
註釋格式:/* 註釋內容 */
行頭註釋:在代碼行的開頭進行註釋。主要爲了使該行代碼失去意義。
註釋格式:// 註釋內容
行尾註釋:尾端(trailing)--極短的註釋,在代碼行的行尾進行註釋。一般與代碼行後空8(至少4)個格,所有註釋必須對齊。
註釋格式:代碼 + 8(至少4)個空格 + // 註釋內容
2、塊(block)--塊註釋:/*……*/
註釋若干行,通常用於提供文件、方法、數據結構等的意義與用途的說明,或者算法的描述。一般位於一個文件或者一個方法的前面,起到引導的作用,也可以根據需要放在合適的位置。這種域註釋不會出現在HTML報告中。註釋格式通常寫成:
/*
* 註釋內容
*/
3、文檔註釋:/**……*/
註釋若干行,並寫入javadoc文檔。每個文檔註釋都會被置於註釋定界符
/**......*/之中,註釋文檔將用來生成HTML格式的代碼報告,所以註釋文
檔必須書寫在類、域、構造函數、方法,以及字段(field)定義之前。註釋文檔由兩部分組成——描述、塊標記。註釋文檔的格式如下:
/**
* The doGet method of the servlet.
* This method is called when a form has its tag value method
* equals to get.
* @param request
* the request send by the client to the server
* @param response
* the response send by the server to the client
* @throws ServletException
* if an error occurred
* @throws IOException
* if an error occurred
*/
public void doGet (HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doPost(request, response);
}
前兩行爲描述,描述完畢後,由@符號起頭爲塊標記註釋。更多有關文檔注
釋和javadoc的詳細資料,參見javadoc的主頁: http://java.sun.com/javadoc/index.html
4、javadoc註釋標籤語法
@author 對類的說明 標明開發該類模塊的作者
@version 對類的說明 標明該類模塊的版本
@see 對類、屬性、方法的說明 參考轉向,也就是相關主題
@param 對方法的說明 對方法中某參數的說明
@return 對方法的說明 對方法返回值的說明
@exception 對方法的說明 對方法可能拋出的異常進行說明
JAVA註釋方法及格式
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.