單行注釋和多行注釋

標籤：

我們在實際編碼中，總是需要為程式添加一些注釋。

什麼是注釋？注釋就是一段文字，這段文字並不是必須的，也不直接參与代碼運行。

注釋用來說明某段代碼的作用，或者說明某個類的用途，每個方法的功能，以及該方法的參數和返回值的資料類型及意義等。

為什麼要添加註釋？

1，永遠不要過於相信自己的理解力。為了過段時間還能簡單明了的看懂自己的以前的代碼，建議添加註釋。

2，可讀性第一，效率第二。團隊協同開發中，團隊成員的溝通比較重要，為了自己寫的代碼能被整個團隊理解，建議添加註釋。

3，代碼即文檔。自己平時寫一些代碼，為了產生一些規範的文檔，建議添加註釋。

實際工作中，經常會聽到一些同事說別人的代碼沒注釋怎麼怎麼樣，實際上寫的漂亮的代碼不需要太多的注釋，相反的，我個人對於滿螢幕的注釋或者是一些無用的代碼極其反

感，特別是使用git，svn等工具做版本管理之後，我都會把那些無用的注釋掉的代碼全部刪掉。

這裡整理一下我對注釋的個人理解：

1，必要的注釋還是必須要有的，比如說Javabean中的欄位意義，就應該有相關的注釋。比如說一些編碼中暫時實現功能，但是存在一些不好的待最佳化的地方，我一般會寫一個

TODO，實現準系統後續我自己再回過頭來完善。

2，不要寫一些白癡的無用注釋，不要保留任何一行被注釋掉的代碼，現在代碼一般都有版本工具做管理，所以根本不用擔心代碼會丟掉。

3，嚴格的遵守Java的命名規範，不用擔心變數名稱太長，不用擔心方法名稱太長，合理的一個英語的翻譯命名比寫那些無用的漢語注釋強多啦。

程式注釋是原始碼的一個重要部分，對於一份規範的程式原始碼來說，注釋應該佔到原始碼的三分之一左右。

幾乎所有的程式設計語言都提供了注釋的功能，一般的程式設計語言都提供了基本的單行注釋和多行注釋，Java也不例外。除此之外，Java語言還提供了一種文檔注釋。

這篇部落格先整理一下Java中的單行注釋和多行注釋，文檔注釋一般用來產生API。

後續我會將自己的一套架構整理一份相關的API，所以有關Java的文檔注釋，接下來我會專門寫一篇部落格。

單行注釋和多行注釋

單行注釋就是在程式中注釋一行代碼，在Java語言中，將雙斜線"//"放在需要注釋的內容之前就可以啦。

在eclipse中，單行注釋的快速鍵是command+/，按一次是添加註釋，在按一次就是取消注釋。

多行注釋就是一次性的將程式中的多行代碼注釋掉，在Java語言中，使用"/*"和"*/"將程式中需要注釋的內容包含起來，"/*"表示注釋開始，"*/"表示注釋結束。

在eclipse中，多行注釋的快速鍵是command+control+/，使用的時候要選中代碼，我一般很少用多行注釋。

現在貼出一段代碼，來示範一下Java中的單行注釋和多行注釋。

/** * Java的單行注釋和多行注釋. *  * @author LinkinPark */public class Comment{public static void main(String[] args){// 這裡是Java的單行注釋System.out.println("示範Java的單行注釋。。。");/* * 這裡是Java的多行注釋 */System.out.println("示範Java的多行注釋。。。");}}

單行注釋和多行注釋