Java中的單行註解與多行註釋

在程式設計中，註解是不可或缺的一部分，註解一方面可以看清程式碼的結構，找起來更方便，另一方面，也有利於同事之間的工作交接。那麼今天就跟大家聊聊Java中的單行註解和多行註解吧，有需要的朋友可以參考一下，希望對你有幫助。

什麼是註解？ 註解就是一段文字，這段文字並不是必須的，也不直接參與程式碼運行。

註解用來說明某段程式碼的作用，或說明某個類別的用途，每個方法的功能，以及該方法的參數和傳回值的資料型別及意義等。

為什麼要加入註解？

1，永遠不要過度相信自己的理解力。為了過段時間還能簡單明了的看懂自己的先前的程式碼，建議加入註解。
2，可讀性第一，效率第二。團隊協同開發中，團隊成員的溝通比較重要，為了自己寫的程式碼能被整個團隊理解，建議加入註解。
3，程式碼即文檔。自己平常寫一些程式碼，為了產生一些規範的文檔，建議加入註解。

實際工作中，經常會聽到一些同事說別人的程式碼沒註釋怎麼樣，實際上寫的漂亮的程式碼不需要太多的註釋，相反的，我個人對於滿螢幕的註釋或是一些無用的程式碼極為反感，特別是用git，svn等工具做版本管理之後，我都會把那些無用的註解掉的程式碼全部刪掉。

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

1，必要的註解還是必須要有的，比如說Javabean中的欄位意義，就應該有相關的註解。例如說一些編碼中暫時實現功能，但是存在一些不好的待優化的地方，我一般會寫一個TODO，實現基本功能後續我自己再回過頭來完善。
2，不要寫一些白痴的無用註釋，不要保留任何一行被註解掉的程式碼，現在程式碼一般都有版本工具做管理，所以根本不用擔心程式碼會丟掉。
3，嚴格的遵守Java的命名規範，不用擔心變數名稱太長，不用擔心方法名稱太長，合理的一個英語的翻譯命名比寫那些無用的漢語註釋強多啦。

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

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

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

單行註解與多行註解

單行註解就是在程式中註解一行程式碼，在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的多行注释。。。");
 }
}

以上是Java中的單行註解與多行註釋的詳細內容。更多資訊請關注PHP中文網其他相關文章！