IT兄弟連 Java語法教程 注釋與編碼規範

• 2019 年 10 月 5 日
• 筆記

版權聲明：本文為部落客原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接和本聲明。

本文鏈接：https://blog.csdn.net/ITXDL123/article/details/95302381

在程式程式碼中適當地添加註釋可以提高程式的可讀性和可維護性。好的編碼規範可以使程式更易閱讀和理解。下面將介紹Java中的集中程式碼注釋以及應該注意的編碼規範。

程式碼注釋

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

● 單行注釋

「//」為單行注釋標記，從符號「//」開始直到換行為止的所有內容均為注釋而被編譯器忽略。語法如下：

//注釋內容

例如，以下程式碼為聲明的int型變數添加註釋：

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

● 多行注釋

「/* */」為多行注釋標記，符號「/*」與「*/」之間的所有內容均為注釋內容。注釋中的內容可以換行。語法如下：

/*

*注釋內容1

*注釋內容2

*…

*/

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

/*

*程式名稱：Hello word //開發時間：2018-7-25

*/

但在多行注釋中不可以嵌套多行注釋，那樣是非法的。

● 文檔注釋

「/** */」為文檔注釋標記。符號「/**」與「*/」之間的內容均為文檔注釋內容。當文檔注釋出現在聲明(如類的聲明、類的成員變數的聲明、類的成員方法聲明等)之前時，會被javadoc文檔工具讀取作為javadoc文檔內容。文檔注釋的語法如下：

/**

*注釋內容

*/

一定要養成良好的編程風格，軟體編碼規範中提到「可讀性第一，效率第二」，所以程式設計師必須要在程式中添加適量的注釋來提高程式的可讀性和可維護性，程式中注釋要佔程式程式碼總量的20%～50%。

編碼規範

在學習開發的過程中要養成良好的編碼習慣，因為規整的程式碼格式會給程式的開發與日後的維護提供很大方便。在此對編碼規範做了以下總結：

● 每條語句要單獨佔一行，一條命令要以分號結束。

● 在聲明變數時，盡量使每個變數的聲明單獨佔一行，即使是相同的數據類型也要將其放置在單獨的一行上，這樣有助於添加註釋。對於局部變數應在聲明的同時對其進行初始化。

● 在Java程式碼中，關鍵字與關鍵字間如果有多個空格，這些空格均被視為一個。多行空格沒有任何意義。為了便於理解、閱讀，應控制好空格的數量。

● 為了方便日後的維護，不要使用技術性很高、難懂、易混淆判斷的語句。由於程式的開發與維護不能是同一個人，所以應盡量使用簡單的技術完成程式需要的功能。

● 對於關鍵的方法要多加註釋，這樣有助於閱讀者了解程式碼結構。