Java代碼注釋

標籤：資訊   編譯   單行注釋   可維護性   聲明變數   back   定義   符號   style   

　　通過代碼注釋，可提高程式的可讀性。注釋中包含了程式的資訊，可以協助從程式員更好的閱讀和理解程式。Java源檔案的任意位置都可以添加註釋語句。注釋的文字Java編譯器不進行編譯，所有代碼中的注釋文字對程式不產生影響。Java提供了三種注釋方法，分別為單行注釋，多行注釋，文檔注釋。

 

　　1 單行注釋

　　“//”為單行注釋的符號，從符號“//”開始到換行位置均為注釋而被Java編譯器忽略。文法如下：

      //注釋內容

　　例如：以下代碼為聲明int型變數添加註釋。

　　int age;　　　　//定義int型變數用於儲存年齡資訊

 

　　2 多行注釋

　　“/**/”為多行注釋標記，符號“/*”與“*/”之間的所有內容都為注釋內容。注釋中的內容可以】換行。

　　文法如下：

　　/*

　　注釋內容1

　　注釋內容2 

　　*/

 

　　注意

　　多行注釋中可以嵌套單行，例如：

　　/*

　　程式名稱：hello Word //開發時間為2017年

　　*/

 

　　但是在多行注釋中不能嵌套多行注釋，例如：

　　/*

　　　　程式名稱：hello Word

　　　　/*

　　　　開發時間：2017年

　　　　CHEN

　　　　*/

　　*/

　　此程式為錯誤的。

 

　　3 文檔注釋

　　“/***/”為文檔注釋的符號，符號“/**”與符號“*/”之間額內容為注釋內容。當文檔注釋出現在聲明變數（如類的聲、明類成員變數的聲明、類成員方法的聲明等）之前時，會被Javadoc文檔工讀取為Javadoc文檔內容。文檔注釋的格式與多行注釋的格式相同，對於初學者而言，文檔注釋並不是很重要，瞭解即可。

　　

　　說明

　　一定要養成良好的編程風格，軟體編程規範中提到“可讀性第一，，效率第二”，所以程式員一定要在編程中添加適量的注釋來提高代碼的可讀性和可維護性。程式中注釋要佔程式碼總量的20%~50%。

Java代碼注釋