JAVA註釋方法及格式

時間 2019-11-12

標籤 java 註釋方法及格欄目 Java 简体版

原文原文鏈接

JAVA註釋方法及格式

1、單行(single-line)--短註釋：//……

單獨行註釋：在代碼中單起一行註釋，註釋前最好有一行空行，並與其後的代碼具備同樣的縮進層級。若是單行沒法完成，則應採用塊註釋。
註釋格式：/* 註釋內容 */
行頭註釋：在代碼行的開頭進行註釋。主要爲了使該行代碼失去意義。
註釋格式：// 註釋內容
行尾註釋：尾端(trailing)--極短的註釋，在代碼行的行尾進行註釋。通常與代碼行後空8（至少4）個格，全部註釋必須對齊。
註釋格式：代碼 + 8（至少4）個空格 + // 註釋內容html

2、塊(block)--塊註釋：/……/

註釋若干行，一般用於提供文件、方法、數據結構等的意義與用途的說明，或者算法的描述。通常位於一個文件或者一個方法的前面，起到引導的做用，也能夠根據須要放在合適的位置。這種域註釋不會出如今HTML報告中。註釋格式一般寫成：
/*
* 註釋內容
*/java

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  對方法的說明對方法可能拋出的異常進行說明spa

JAVA註釋具體實現

1、源文件註釋

源文件註釋採用 /** …… */，在每一個源文件的頭部要有必要的註釋信息，包括：文件名；文件編號；版本號；做者；建立時間；文件描述包括本文件歷史修改記錄等。中文註釋模版：
/**
* 文件名 :
* CopyRright (c) 2008-xxxx:
* 文件編號：
* 創建人：
* 日    期：
* 修改人：
* 日   期：
* 描   述：
* 版本號：
*/orm

2、類（模塊）註釋：

類（模塊）註釋採用 /** ……*/，在每一個類（模塊）的頭部要有必要的註釋信息，包括：工程名；類（模塊）編號；命名空間；類能夠運行的JDK版本；版本號；做者；建立時間；類（模塊）功能描述（如功能、主要算法、內部各部分之間的關係、該類與其類的關係等，必要時還要有一些如特別的軟硬件要求等說明）；主要函數或過程清單及本類（模塊）歷史修改記錄等。
英文註釋模版：
/**
* CopyRright (c)2008-xxxx:
* Project:
* Module ID:
* Comments:
* JDK version used:
* Namespace:
* Author：
* Create Date：
* Modified By：
* Modified Date:
* Why & What is modified
* Version:
*/
若是模塊只進行部分少許代碼的修改時，則每次修改須添加如下注釋：
//Rewriter
//Rewrite Date： Start1：
/* 原代碼內容*/
//End1：
將原代碼內容註釋掉，而後添加新代碼使用如下注釋：
//Added by
//Add date： Start2：
//End2：
若是模塊輸入輸出參數或功能結構有較大修改，則每次修改必須添加如下
註釋：
//Log ID：
//Depiction：
//Writer：修改者中文名
//Rewrite Date：server

2.1 接口註釋： htm

接口註釋採用 /** …… */，在知足類註釋的基礎之上，接口註釋應該包含描述接口的目的、它應如何被使用以及如何不被使用，塊標記部分必須註明做者和版本。在接口註釋清楚的前提下對應的實現類能夠不加註釋。
接口

3、構造函數註釋：

構造函數註釋採用 /** …… */，描述部分註明構造函數的做用，不必定有塊標記部分。
註釋模版一：
/**
* 默認構造函數
*/
註釋模版二：
/**
* Description :       帶參數構造函數,
*                       初始化模式名,名稱和數據源類型
* @param schema：   模式名
* @param name：   名稱
* @param type：數據源類型
*/

4、函數註釋：

函數註釋採用 /** ……*/，在每一個函數或者過程的前面要有必要的註釋信息，包括：函數或過程名稱；功能描述；輸入、輸出及返回值說明；調用關係及被調用關係說明等。函數註釋裏面能夠不出現版本號（@version）。
註釋模版一：
/**
  * 函數名 :
  * 功能描述：
* 輸入參數:
*
*
* 返回值:  - 類型
*
* 異    常：
* 創建人:
* 日    期:
* 修改人:
* 日    期:
*/
註釋模版二：
/**
* FunName:           getFirstSpell
  * Description :      獲取漢字拼音首字母的字符串，
*                   被生成百家姓函數調用
  * @param：         str the String是包含漢字的字符串
  * @return String：漢字返回拼音首字母字符串；
*                  英文字母返回對應的大寫字母；
*                 其餘非簡體漢字返回 '0'；
* @Author:       ghc
* @Create Date: 2008-07-02
*/