JAVA注釋詳解以及實戰應用

概述

幾乎所有程式語言都允許程式設計師在代碼中輸入注釋（comment），編譯器會忽略注釋的內容。因此，注釋不會影響程序的運行結果。注釋的真正作用是：它可以向任何閱讀代碼的人描述或者解釋程序的實現思路、如何使用以及其他任何相關信息。

JAVA中的注釋

JAVA提供了三種注釋方式，方便我們在不同的場景去使用：

1、單行注釋

如果程序中的每一行是以//開頭的，那麼這行就是一個單行注釋，例如：

2、多行注釋

程序中，以/*，以*/結尾，中間的所有的內容都是注釋，雖然這種注釋叫做多行注釋，但是注釋的內容可以是單行的，也可以是多行的，例如：

3、javadoc注釋

javadoc注釋又叫做歸檔注釋，也叫作說明注釋。它是以/**開頭。以*/結尾，例如：

因為注釋的內容可以是任何字符，仔細對比多行注釋和javadoc注釋，我們會發現，如果我們把javadoc注釋（以/**開頭）開頭的第二個*當做注釋內容的話，他就會變成一個多行注釋（以/*開頭），從這個角度看的話，我們可以說javadoc注釋就是一種特殊的多行注釋。但是這樣的結果是不對的，因為javadoc注釋的真是用處是，它允許我們在程序中嵌入關於程序本身的信息，Javadoc的工具軟體通過識別這些信息輸出HTML版本的說明文檔。這是至關重要的，尤其是在真實的項目中。

在javadoc注釋中，我們通過一些標籤來說記錄程序信息，javadoc工具軟體能夠識別的標籤如下圖所示：

Javadoc注釋一般用來注釋類和方法，通過上表的標籤來記錄類或者方法的信息，例如：

我們可以通過javadoc工具來處理一下NumberTest.java這個文件：

經過javadoc軟體處理之後，我們得到一些說明性的html文件，如下：

我們打開index.html，看到的就是關於NumberTest類的說明：

看到這個結果，你知道平時看的JDK的那些API是怎麼來的了嗎？這就是javadoc注釋的偉大作用。

注釋在實戰中的應用

企業級產品開發中，對注釋的要求取決於項目的規模和團隊的正規化程度。對於一個專業的軟體開發人員來說，對javadoc的使用程序有時候直接決定這在項目中的角色，也會影響面試的結果和薪水的水平，因為它能夠反映開發人員參與過項目的規模，以及之前躲在團隊的專業化程度。

對注釋的重視是一個專業團隊必不可少的一部分。一般來說，每個專業的團隊都有一個關於注釋的書寫規範要求，下面我給出注釋規範供大家參考：

1、版權注釋

2、類注釋

3、構造方法注釋

4、其他方法注釋

5、代碼塊注釋

6、單句注釋

7、欄位名注釋