java程序員有哪些應該注意的編碼規(guī)范?

Java編碼規(guī)范:　盡量使用完整的英文描述符采用適用于相關領域的術語采用大小寫混合使名字可讀盡量少用縮寫，但如果用了，必須符合整個工程中的統(tǒng)一定義避免使用長的名字（小于15個字母為正常選擇）避免使用類似的名字，或者僅僅是大小寫不同的名字避免使用下劃線（除靜態(tài)常量等）標識符類型說明包（Package）的命名Package的名字應該采用完整的英文描述符，都是由一個小寫單詞組成。并且包名的前綴總是一個頂級域名

成都創(chuàng)新互聯公司主營含山網站建設的網絡公司,主營網站建設方案,成都App定制開發(fā),含山h5成都微信小程序搭建,含山網站營銷推廣歡迎含山等地區(qū)企業(yè)咨詢

，通常是com、edu、gov、mil、net、org等；如：com.yjhmily.test類（Class）的命名類名應該是個一名詞，采用大小寫混合的方式，每個單詞的首字母大寫。盡量保證類名簡潔而富于描述。

為什么要為程序添加注釋，在java程序中如何為程序添加注釋？

定義規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。（這些規(guī)范并不是一定要絕對遵守，但是一定要讓程序有良好的可讀性）。

// 注釋一行 ?

/* ...... */ 注釋若干行 ?

/** ...... */ 注釋若干行，并寫入 javadoc 文檔

如下代碼：

package?com.qiu.lin.he;

/**

*?第三種注釋方式

*?@author?Administrator

*

*/

public?class?CeShi?{

public?static?void?main(String[]?args)?{

int?str?=?107653;

//System.out.print(str?/?(24?*?60?*?60)?+?"天");

/*System.out.print(str?%?(24?*?60?*?60)?/?(60?*?60)?+?"小時");

System.out.print(str?%?(24?*?60?*?60)?%?(60?*?60)?/?60?+?"分鐘");*/

System.out.print(str?%?(24?*?60?*?60)?%?(60?*?60)?%?60?+?"秒");

}

}

編程中的注釋分為三類 單行注釋，多行注釋，文檔注釋；

暈~~~ 自己還是找到了 ·· 留給后來人吧···

java文檔注釋（有示例）

Java代碼規(guī)范--注釋

@author LEI

@version 1.10 2005-09-01

1 注釋文檔的格式注釋文檔將用來生成HTML格式的代碼報告，所以注釋文檔必須書寫在類、域、構造函數、方法、定義之前。注釋文檔由兩部分組成——描述、塊標記。

例如：

/**

* The doGet method of the servlet.

* This method is called when a form has its tag value method equals to get.

*

* @param request

* the request send by the client to the server

* @param response

* the response send by the server to the client

* @throws ServletException

* if an error occurred

* @throws IOException

* if an error occurred

*/

public void doGet (HttpServletRequest request, HttpServletResponse response)

throws ServletException, IOException {

doPost(request, response);

}

前兩行為描述，描述完畢后，由@符號起頭為塊標記注視。

2 注釋的種類2.1 文件頭注釋

文件頭注釋以 /*開始，以*/結束，需要注明該文件創(chuàng)建時間，文件名，命名空間信息。

例如：

/*

* Created on 2005-7-2

* /

2.2 類、接口注釋

類、接口的注釋采用 /** … */，描述部分用來書寫該類的作用或者相關信息，塊標記部分必須注明作者和版本。

例如：

/**Title: XXXX DRIVER 3.0

*Description: XXXX DRIVER 3.0

*Copyright: Copyright (c) 2003

*Company:XXXX有限公司

*

* @author Java Development Group

* @version 3.0

*/

例如：

/**

* A class representing a window on the screen.

* For example:

*

* Window win = new Window(parent);

* win.show();

*

*

* @author Sami Shaio

* @version %I%, %G%

* @see java.awt.BaseWindow

* @see java.awt.Button

*/

class Window extends BaseWindow {

...

}

2.3 構造函數注釋

構造函數注釋采用 /** … */，描述部分注明構造函數的作用，不一定有塊標記部分。

例如：

/**

* 默認構造函數

*/

有例如：

/**

* 帶參數構造函數,初始化模式名,名稱和數據源類型

*

* @param schema

* Ref 模式名

* @param name

* Ref 名稱

* @param type

* byVal 數據源類型

*/

2.4 域注釋

域注釋可以出現在注釋文檔里面，也可以不出現在注釋文檔里面。用/** … */的域注釋將會被認為是注釋文檔熱出現在最終生成的HTML報告里面，而使用/* … */的注釋會被忽略。

例如：

/* 由于triger和表用一個DMSource，所以要區(qū)分和表的遷移成功標記 */

boolean isTrigerSuccess = false;

又例如：

/** 由于triger和表用一個DMSource，所以要區(qū)分和表的遷移成功標記 */

boolean isTrigerSuccess = false;

再例如：

/**

* The X-coordinate of the component.

*

* @see #getLocation()

*/

int x = 1263732;

2.5 方法注釋

方法注釋采用 /** … */，描述部分注明方法的功能，塊標記部分注明方法的參數，返回值，異常等信息。例如：

/**

* 設置是否有外碼約束

*

* @param conn

* Connection 與數據庫的連接

*/

2.6 定義注釋

規(guī)則同域注釋。

3 注釋塊標記3.1 標記的順序

塊標記將采用如下順序：

…

*

* @param (classes, interfaces, methods and constructors only)

* @return (methods only)

* @exception (@throws is a synonym added in Javadoc 1.2)

* @author (classes and interfaces only, required)

* @version (classes and interfaces only, required. See footnote 1)

* @see

* @since

* @serial (or @serialField or @serialData)

* @deprecated (see How and When To Deprecate APIs)

* …

一個塊標記可以根據需要重復出現多次，多次出現的標記按照如下順序：

@author 按照時間先后順序（chronological）

@param 按照參數定義順序（declaration）

@throws 按照異常名字的字母順序（alphabetically）

@see 按照如下順序：

@see #field

@see #Constructor(Type, Type...)

@see #Constructor(Type id, Type id...)

@see #method(Type, Type,...)

@see #method(Type id, Type, id...)

@see Class

@see Class#field

@see Class#Constructor(Type, Type...)

@see Class#Constructor(Type id, Type id)

@see Class#method(Type, Type,...)

@see Class#method(Type id, Type id,...)

@see package.Class

@see package.Class#field

@see package.Class#Constructor(Type, Type...)

@see package.Class#Constructor(Type id, Type id)

@see package.Class#method(Type, Type,...)

@see package.Class#method(Type id, Type, id)

@see package

3.2 標記介紹

3.2.1 @param標記

@param后面空格后跟著參數的變量名字（不是類型），空格后跟著對該參數的描述。

在描述中第一個名字為該變量的數據類型，表示數據類型的名次前面可以有一個冠詞如：a,an,the。如果是int類型的參數則不需要注明數據類型。例如：

…

* @param ch the char 用用來……

* @param _image the image 用來……

* @param _num 一個數字……

…

對于參數的描述如果只是一短語，最好不要首字母大寫，結尾也不要句號。

對于參數的描述是一個句子，最好不要首字母大寫，如果出現了句號這說明你的描述不止一句話。如果非要首字母大寫的話，必須用句號來結束句子。（英文的句號）

公司內部添加ByRef和ByVal兩個標記，例如：

* @param _image the image ByRef 用來……

說明該參數是引用傳遞（指針），ByVal可以省略，表示是值傳遞。

3.2.2 @return標記

返回為空（void）的構造函數或者函數，@return可以省略。

如果返回值就是輸入參數，必須用與輸入參數的@param相同的描述信息。

必要的時候注明特殊條件寫的返回值。

3.2.3 @throws 標記

@throws以前使用的是@exception。

@throws的內容必須在函數的throws部分定義。

3.2.4 @author標記

類注釋標記。

函數注釋里面可以不出現@author。

3.2.5 @version

類注釋標記。

文章出處：

java 注釋規(guī)范

/**

*?方法功能描述

*?

*?@param?參數說明

*?@author??作者

*?@return?返回格式

*?@exception??異常

*/

java工作中良好的代碼注釋習慣是什么

注釋是為了方便自己或代碼維護方更容易地讀懂代碼的用處。

一、背景?

1、當我們第一次接觸某段代碼，但又被要求在極短的時間內有效地分析這段代碼，我們需要什么樣的注釋信息？?

2、怎么樣避免我們的注釋冗長而且凌亂不堪呢？?

3、在多人協(xié)同開發(fā)、維護的今天，我們需要怎么樣的注釋來保證高質、高交的進行開發(fā)和維護工作呢？?

二、意義?

程序中的注釋是程序設計者與程序閱讀者之間通信的重要手段。應用注釋規(guī)范對于軟件本身和軟件開發(fā)人員而言尤為重要。并且在流行的敏捷開發(fā)思想中已經提出了將注釋轉為代碼的概念。好的注釋規(guī)范可以盡可能的減少一個軟件的維護成本?,?并且?guī)缀鯖]有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)人員來維護。好的注釋規(guī)范可以改善軟件的可讀性，可以讓開發(fā)人員盡快而徹底地理解新的代碼。好的注釋規(guī)范可以最大限度的提高團隊開發(fā)的合作效率。長期的規(guī)范性編碼還可以讓開發(fā)人員養(yǎng)成良好的編碼習慣，甚至鍛煉出更加嚴謹的思維能力。?

三、注釋的原則?

1、 注釋形式統(tǒng)一?

在整個應用程序中，使用具有一致的標點和結構的樣式來構造注釋。如果在其他項目組發(fā)現他們的注釋規(guī)范與這份文檔不同，按照他們的規(guī)范寫代碼，不要試圖在既成的規(guī)范系統(tǒng)中引入新的規(guī)范。?

2、 注釋的簡潔?

內容要簡單、明了、含義準確，防止注釋的多義性，錯誤的注釋不但無益反而有害。?

3、 注釋的一致性?

在寫代碼之前或者邊寫代碼邊寫注釋，因為以后很可能沒有時間來這樣做。另外，如果有機會復查已編寫的代碼，在今天看來很明顯的東西六周以后或許就不明顯了。通常描述性注釋先于代碼創(chuàng)建，解釋性注釋在開發(fā)過程中創(chuàng)建，提示性注釋在代碼完成之后創(chuàng)建。修改代碼的同時修改相應的注釋，以保證代碼與注釋的同步。?

4、 注釋的位置?

保證注釋與其描述的代碼相鄰，即注釋的就近原則。對代碼的注釋應放在其上方相鄰或右方的位置，不可放在下方。避免在代碼行的末尾添加注釋；行尾注釋使代碼更難閱讀。不過在批注變量聲明時，行尾注釋是合適的；在這種情況下，將所有行尾注釋要對齊。?

5、 注釋的數量?

注釋必不可少，但也不應過多，在實際的代碼規(guī)范中，要求注釋占程序代碼的比例達到20%左右。注釋是對代碼的“提示”，而不是文檔，程序中的注釋不可喧賓奪主，注釋太多了會讓人眼花繚亂，注釋的花樣要少。不要被動的為寫注釋而寫注釋。?

6、刪除無用注釋?

在代碼交付或部署發(fā)布之前，必須刪掉臨時的或無關的注釋，以避免在日后的維護工作中產生混亂。?

7、 復雜的注釋?

如果需要用注釋來解釋復雜的代碼，請檢查此代碼以確定是否應該重寫它。盡一切可能不注釋難以理解的代碼，而應該重寫它。盡管一般不應該為了使代碼更簡單便于使用而犧牲性能，但必須保持性能和可維護性之間的平衡。?

8、 多余的注釋?

描述程序功能和程序各組成部分相互關系的高級注釋是最有用的，而逐行解釋程序如何工作的低級注釋則不利于讀、寫和修改，是不必要的，也是難以維護的。避免每行代碼都使用注釋。如果代碼本來就是清楚、一目了然的則不加注釋，避免多余的或不適當的注釋出現。?

9、必加的注釋?

典型算法必須有注釋。在代碼不明晰或不可移植處必須有注釋。在代碼修改處加上修改標識的注釋。在循環(huán)和邏輯分支組成的代碼中添加注釋。為了防止問題反復出現，對錯誤修復和解決方法的代碼使用注釋，尤其是在團隊環(huán)境中。?

10、注釋在編譯代碼時會被忽略，不編譯到最后的可執(zhí)行文件中，所以注釋不?

會增加可執(zhí)行文件的大小。?

四、JAVA注釋技巧?

1、空行和空白字符也是一種特殊注釋。利用縮進和空行，使代碼與注釋容易區(qū)?

別，并協(xié)調美觀。?

2、當代碼比較長，特別是有多重嵌套時，為了使層次清晰，應當在一些段落的?

結束處加注釋（在閉合的右花括號后注釋該閉合所對應的起點），注釋不能?

寫得很長，只要能表示是哪個控制語句控制范圍的結束即可，這樣便于閱讀。?

3、將注釋與注釋分隔符用一個空格分開，在沒有顏色提示的情況下查看注釋時，?

這樣做會使注釋很明顯且容易被找到。?

4、不允許給塊注釋的周圍加上外框。這樣看起來可能很漂亮，但是難于維護。?

5、每行注釋（連同代碼）不要超過120個字(1024×768)，最好不要超過80?

字(800×600)?。?

6、Java編輯器（IDE）注釋快捷方式。Ctrl+/?注釋當前行,再按則取消注釋。?

7、對于多行代碼的注釋，盡量不采用“/*......*/”，而采用多行“//”注釋，?

這樣雖然麻煩，但是在做屏蔽調試時不用查找配對的“/*......*/”。?

8、注釋作為代碼切換開關，用于臨時測試屏蔽某些代碼。

新聞名稱：java中代碼注釋規(guī)范,java代碼怎么注釋
當前URL：http://chinadenli.net/article8/dsehiip.html

成都網站建設公司_創(chuàng)新互聯，為您提供域名注冊、標簽優(yōu)化、自適應網站、手機網站建設、定制開發(fā)、用戶體驗

廣告

聲明：本網站發(fā)布的內容（圖片、視頻和文字）以用戶投稿、用戶轉載內容為主，如果涉及侵權請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網站立場，如需處理請聯系客服。電話：028-86922220；郵箱：631063699@qq.com。內容未經允許不得轉載，或轉載時需注明來源： 創(chuàng)新互聯