第一篇：java注釋規范總結大全

在軟件開發的過程中總是強調注釋的規范，但是沒有一個具體的標準進行說明，通常都是在代碼編寫規范中簡單的描述幾句，不能作為一個代碼注釋檢查的標準和依據，做什么都要有一個依據嗎:),現在我特整理了一個《Java的注釋規范》，內容來自網絡、書籍和自己的實際積累。

JAVA注釋規范

版本/狀態 作者 版本日期

1.0 ghc 2008-07-02

一、背景

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

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

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

二、意義

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

三、注釋的原則

1、注釋形式統一

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

2、注釋的簡潔

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

3、注釋的一致性

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

4、注釋的位置

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

5、注釋的數量

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

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

7、復雜的注釋

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

8、多余的注釋

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

9、必加的注釋

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

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

會增加可執行文件的大小。

四、JAVA注釋技巧

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

別，并協調美觀。

2、當代碼比較長，特別是有多重嵌套時，為了使層次清晰，應當在一些段落的結束處加注釋（在閉合的右花括號后注釋該閉合所對應的起點），注釋不能

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

3、將注釋與注釋分隔符用一個空格分開，在沒有顏色提示的情況下查看注釋時，這樣做會使注釋很明顯且容易被找到。

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

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

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

7、對于多行代碼的注釋，盡量不采用“/*......*/”，而采用多行“//”注釋，這樣雖然麻煩，但是在做屏蔽調試時不用查找配對的“/*......*/”。

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

例一：

//*/

codeSegement1;//*/

改動第一行就成了：

/*/

codeSegement1;//*/ 例二：

//----------------------第一段有效，第二段被注釋

//*/

codeSegement1;/*/

codeSegement2;//*/

只需刪除第一行的/就可以變成：

//----------------------第一段被注釋，第二段有效

/*/

codeSegement1;/*/

codeSegement2;//*/

五、JAVA注釋方法及格式

1、單行(single-line)--短注釋：//??

單獨行注釋：在代碼中單起一行注釋，注釋前最好有一行空行，并與其后的代碼具有一樣的縮進層級。如果單行無法完成，則應采用塊注釋。

注釋格式：/* 注釋內容 */

行頭注釋：在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。

注釋格式：// 注釋內容

行尾注釋：尾端(trailing)--極短的注釋，在代碼行的行尾進行注釋。一般與代碼行后空8（至少4）個格，所有注釋必須對齊。

注釋格式：代碼 + 8（至少4）個空格 + // 注釋內容

2、塊(block)--塊注釋：/*??*/ 注釋若干行，通常用于提供文件、方法、數據結構等的意義與用途的說明，或者算法的描述。一般位于一個文件或者一個方法的前面，起到引導的作用，也可以根據需要放在合適的位置。這種域注釋不會出現在HTML報告中。注釋格式通常寫成：

/*

* 注釋內容

*/

3、文檔注釋：/**??*/

注釋若干行，并寫入javadoc文檔。每個文檔注釋都會被置于注釋定界符

/**......*/之中，注釋文檔將用來生成HTML格式的代碼報告，所以注釋文

檔必須書寫在類、域、構造函數、方法，以及字段(field)定義之前。注釋文檔由兩部分組成——描述、塊標記。注釋文檔的格式如下：

/**

* 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);}

前兩行為描述，描述完畢后，由@符號起頭為塊標記注釋。更多有關文檔注

釋和javadoc的詳細資料，參見javadoc的主頁： http://java.sun.com/javadoc/index.html

4、javadoc注釋標簽語法

@author

對類的說明 標明開發該類模塊的作者

@version

對類的說明 標明該類模塊的版本

@see

對類、屬性、方法的說明 參考轉向，也就是相關主題

@param

對方法的說明 對方法中某參數的說明

@return

對方法的說明 對方法返回值的說明

@exception 對方法的說明 對方法可能拋出的異常進行說明

六、JAVA注釋具體實現

1、源文件注釋

源文件注釋采用 /** ?? */，在每個源文件的頭部要有必要的注釋信息，包括：文件名；文件編號；版本號；作者；創建時間；文件描述包括本文件歷史修改記錄等。中文注釋模版：

/**

* 文 件 名 :

* CopyRright(c)2008-xxxx: * 文件編號：

* 創 建 人：

* 日

期：

* 修 改 人：

* 日

期：

* 描

述：

* 版 本 號：

*/

2、類（模塊）注釋：

類（模塊）注釋采用 /** ?? */，在每個類（模塊）的頭部要有必要的注釋信息，包括：工程名；類（模塊）編號；命名空間；類可以運行的JDK版本；版本號；作者；創建時間；類（模塊）功能描述（如功能、主要算法、內部各部分之間的關系、該類與其類的關系等，必要時還要有一些如特別的軟硬件要求等說明）；主要函數或過程清單及本類（模塊）歷史修改記錄等。

英文注釋模版：

/**

* CopyRright(c)2008-xxxx:

<展望軟件Forsoft >

* Project:

<項目工程名 >

* Module ID:

<(模塊)類編號，可以引用系統設計中的類編號>

* Comments: <對此類的描述，可以引用系統設計中的描述>

* JDK version used:

* Namespace:

<命名空間>

* Author：

<作者中文名或拼音縮寫>

* Create Date：

<創建日期，格式:YYYY-MM-DD>

* Modified By：

<修改人中文名或拼音縮寫>

* Modified Date: <修改日期，格式:YYYY-MM-DD>

* Why & What is modified <修改原因描述>

* Version:

<版本號>

*/

如果模塊只進行部分少量代碼的修改時，則每次修改須添加以下注釋：

//Rewriter

//Rewrite Date：<修改日期:格式YYYY-MM-DD> Start1：

/* 原代碼內容*/ //End1：

將原代碼內容注釋掉，然后添加新代碼使用以下注釋：

//Added by

//Add date：<添加日期，格式：YYYY-MM-DD> Start2：

//End2：

如果模塊輸入輸出參數或功能結構有較大修改，則每次修改必須添加以下

注釋：

//Log ID： //Depiction：<對此修改的描述> //Writer：修改者中文名

//Rewrite Date：<模塊修改日期，格式：YYYY-MM-DD>

2、接口注釋：

接口注釋采用 /** ?? */，在滿足類注釋的基礎之上，接口注釋應該包含描述接口的目的、它應如何被使用以及如何不被使用，塊標記部分必須注明作者和版本。在接口注釋清楚的前提下對應的實現類可以不加注釋。

3、構造函數注釋：

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

注釋模版一：

/**

* 默認構造函數

*/

注釋模版二：

/**

* Description :

帶參數構造函數，*

初始化模式名,名稱和數據源類型

* @param schema：

模式名

* @param name：

名稱

* @param type： 數據源類型

*/

4、函數注釋：

函數注釋采用 /** ??*/，在每個函數或者過程的前面要有必要的注釋信息，包括：函數或過程名稱；功能描述；輸入、輸出及返回值說明；調用關系及被調用關系說明等。函數注釋里面可以不出現版本號（@version）。

注釋模版一：

/**

* 函 數 名 :

* 功能描述：

* 輸入參數:

<按照參數定義順序>

*

<@param后面空格后跟著參數的變量名字

*

（不是類型），空格后跟著對該參數的描述。> *

* 返 回 值:-類型 <說明>

*

<返回為空（void）的構造函數或者函數，*

@return可以省略;如果返回值就是輸入參數，必須 *

用與輸入參數的@param相同的描述信息;必要的時*

候注明特殊條件寫的返回值。> * 異

常：<按照異常名字的字母順序> * 創 建 人: * 日

期: * 修 改 人: * 日

期: */

注釋模版二：

/**

* FunName:

getFirstSpell

* Description :

獲取漢字拼音首字母的字符串，*

被生成百家姓函數調用

* @param：

str the String是包含漢字的字符串

* @return String：漢字返回拼音首字母字符串；

*

英文字母返回對應的大寫字母；

*

其他非簡體漢字返回 '0'；

* @Author:

ghc * @Create Date: 2008-07-02 */

5、方法注釋：

方法注釋采用 /** ?? */，對于設置(Set 方法)與獲取(Get 方法)成員的方法，在成員變量已有說明的情況下，可以不加注釋；普通成員方法要求說明完成什么功能，參數含義是什么且返回值什么；另外方法的創建時間必須注釋清楚，為將來的維護和閱讀提供寶貴線索。

6、方法內部注釋：

控制結構，代碼做了些什么以及為什么這樣做，處理順序等，特別是復雜的邏輯處理部分，要盡可能的給出詳細的注釋。

7、全局變量注釋：

要有較詳細的注釋，包括對其功能、取值范圍、哪些函數或者過程存取以及存取時注意事項等的說明。

8、局部（中間）變量注釋：

主要變量必須有注釋，無特別意義的情況下可以不加注釋。

9、實參/參數注釋：

參數含義、及其它任何約束或前提條件。

10、字段/屬性注釋： 字段描述，屬性說明。

11、常量：常量通常具有一定的實際意義，要定義相應說明。

第二篇：JAVA代碼注釋規范

JAVA代碼注釋規范

一、規范存在的意義

1.好的注釋規范可以讓人一眼看明白這是干什么的，特別是對于我們這種行業；共同合作完成一個項目需要分工明確，所以也需要有明了的注釋規范。

2.正確的應用注釋規范可以增加代碼的可讀性、理解性。3.好的代碼規范可以提高團隊的開發效率，從而節省時間。4.長期的堅持代碼規范可以讓程序員養成一個良好的習慣，甚至鍛煉出思維。

二、命名規范

1.一般概念

1)盡量使用完整的英文描述。2)采用相對好理解的術語。

3)采用駱駝命名的規范使名字增加可讀性。4)盡量少用縮寫提高可讀性。5)避免名字過長。

6)避免使用類似的名字。7)避免使用特殊符號。2.主要的運用

1)類（class）的命名

2)接口(interface)的命名 +方法(method)的命名 3)參數(param)的命名

三、注釋規范

1.一般概念

1)注釋應該增加代碼的清晰度 2)保持代碼的整潔

3)在寫代碼之前或同時注意寫上注釋

4)注釋出為什么做這件事，做這件事的結果 2.注釋那些部分

1)java文件：版權信息、創建時間、創建人 2)類：目的、所完成功能、版權信息、創建人 3)方法：參數含義、返回值 4)屬性：字段描述

5)接口：目的、創建人、版本號、創建時間

四、代碼格式規范

1.單行注釋://注釋內容，一般與代碼后空4-8格，注釋必須對齊 2.塊狀注釋：/*注釋內容*/，一般是注釋從以/*開始，以*/結束中的所有內容。3.文檔注釋：/**......*/所以注釋文 檔必須書寫在類、域、構造函數、方法，以及字段(field)定義之前.注釋文檔由兩部分組成——描述、塊標記。4.javadoc注釋標簽

@author 對類的說明 標明開發該類模塊的作者

@version 對類的說明 標明該類模塊的版本

@see 對類、屬性、方法的說明 參考轉向，也就是相關主題

@param 對方法的說明 對方法中某參數的說明

@return 對方法的說明 對方法返回值的說明

@exception 對方法的說明 對方法可能拋出的異常進行說明

五、java注釋具體實現

1.源文件注釋

/** *文件名 *創建人 *創建時間 *修改人 *描述 *版本號 */ 2.類注釋

/** *對此類的描述信息 *創建人 *版本號 *創建時間 */ 3.方法的注釋

/** *方法的用處 *該方法的參數列 *該方法返回的值 */ 4.屬性的注釋

/** *字段的描述 */ 5.接口注釋

/** *對此接口的描述 *創建人 *創建時間 *版本號 */ 6.構造方法注釋

/** *描述該構造方法的用處 *該構造方法的參數列 *參數的類型 */

六、Jsp代碼格式規范

1.多行注釋:,一般是注釋從以結束中的所有內容。

2.文本注釋:<%--內容--%>,主要是對該頁面的一些描述，目的、創建人、創建時間、版本號、文件名、備注、修改人等.例如: <%---創建人-創建時間-版本號-文件名-備注-修改人--%> 3.偽劣標簽注釋:<% java語句塊 %> 例如： <% JAVA代碼塊 %> 4.單行注釋：//注釋內容，一般與代碼后空4-8格，注釋必須對齊

七、JS代碼格式規范

1.文本注釋:/** 注釋內容 **/，主要是對該頁面的一些描述，目的、創建人、創建時間、版本號、文件名、備注、修改人等.也可以用于注釋代碼塊。例如: /** *創建人 *創建時間 *版本號 *文件名 *備注 *修改人 **/

2.文本注釋:/** 內容 */ ,主要是對該頁面的一些描述，目的、創建人、創建時間、版本號、文件名、備注、修改人等.也可以用于注釋代碼塊。例如: /** *創建人 *創建時間 *版本號 *文件名 *備注 *修改人 */ 3.單行注釋: //注釋內容，一般與代碼后空4-8格，注釋必須對齊 4.多行注釋: /* 注釋內容 */,一般是注釋從以/* 開始，以*/結束中的所有內容。

八、JS注釋具體實現 1.文件注釋

/** *對此文件的描述信息 *創建人 *版本號 *創建時間 */ 2.方法的注釋

/** *方法的用處 *該方法的參數列 *該方法返回的值 */ 3.模塊的注釋

/** *模塊名稱

*模塊的用處

*/

第三篇：java文件頭注釋格式

myeclipse中java文件頭注釋格式設置

2011-10-08 13:11:33| 分類： IDE|舉報|字號 訂閱

windows->preferences->java->Code Templates->comments->Type->edit Eclipse注釋規范模版總結 新建類文件 /** * @ClassName: ${file_name} * @Description: ${todo}(用一句話描述該文件做什么)* * @author ${user} * @version V1.0 * @Date ${date} ${time} */ 方法 /** * @Title: ${enclosing_method} * @Description: ${todo}(這里用一句話描述這個方法的作用)* @param: ${tags} * @return: ${return_type} * @throws * @author ${user} * @Date ${date} ${time} */

輸入設置模板：

/** * ${file_name} Create on ${date} * * Copyright(c)${date} by taotaosoft * * @author Jerryli * @version 1.0 * */

注意選擇自動添加注釋

養成一個規范的習慣是最好的。

選菜單 windows-->preference Java-->Code Style-->Code Templates code-->new Java files

選中點編輯

${filecomment} ${package_declaration} /** * @author 作者姓名 E-mail: email地址 * @version 創建時間：${date} ${time} * 類說明 */ ${typecomment} ${type_declaration}

Eclipse注釋規范模版總結

1、具體操作

（1）在eclipse中，打開Window->Preference->Java->Code Style->Code Template（2）然后展開Comments節點就是所有需設置注釋的元素，參照2注釋規范對應設置即可

2、注釋規范

（1）文件(Files)注釋標簽 /** * FileName: ${file_name} * @Description: ${todo}(用一句話描述該文件做什么)* All rights Reserved, Designed By ZTE-ITS * Copyright: Copyright(C)2010-2011 * Company ZTE-ITS WuXi LTD.* @author: 名字 * @version V1.0 * Createdate: ${date} ${time} * * Modification History: * Date Author Version Discription * * ${date} wu.zh 1.0 1.0 * Why & What is modified: <修改原因描述> */

（2）類型(Types)注釋標簽（類的注釋）：

/** * @ClassName: ${type_name} * @Description:${todo}(這里用一句話描述這個類的作用)* @author: Android_Robot * @date: ${date} ${time} * * ${tags} */

（3）字段(Fields)注釋標簽：

/** * @Fields ${field} : ${todo}(用一句話描述這個變量表示什么)*/

（4）構造函數標簽：

/** * @Title: ${enclosing_type} * @Description: ${todo}(這里用一句話描述這個方法的作用)* @param: ${tags} * @throws */

（5）方法(Methods)標簽：

/** * @Title: ${enclosing_method} * @Description: ${todo}(這里用一句話描述這個方法的作用)* @param: ${tags} * @return: ${return_type} * @throws */

（6）覆蓋方法(Overriding Methods)標簽: /** *

Title: ${enclosing_method}

Description:

（7）代表方法(Delegate Methods)標簽： /** * ${tags} * ${see_to_target} */

（8）getter方法標簽：

/** * @Title: ${enclosing_method}
* @Description: please write your description
* @return: ${field_type}
*/

（9）setter方法標簽：

/** * @Title: ${enclosing_method}
* @Description: please write your description
* @return: ${field_type}
*/ ren

第四篇：學術論文注釋規范

學術論文注釋規范

一、文后參考文獻及其隨文夾注格式

參考文獻按在正文中出現的先后次序列于文末，以“參考文獻：”（左頂格）作為標識。參考文獻的序號左頂格，并用數字加方括號表示，如[1]，[2]，…；每一條參考文獻條目的最后均以小圓點“.”結束。

引文的起止頁碼以隨文以夾注的形式、用6號宋體標出，其格式為：[序號]（p×）。

各類參考文獻及其在正文中夾注的格式及示例如下：

（一）專著、論文集、學位論文、報告

[序號]主要責任者.文獻題名[文獻類型標識].出版地：出版者，出版年.[1] 列維·布留爾.原始思維[M].北京：商務印書館，1987.[2] 馬克思.恩格斯.共產黨宣言[A].馬克思恩格斯選集[M].第一卷.北京：人民出版社，1972.[3] 洪亮吉.春秋左傳詁[M].卷三.[4] 人事部一·敘人[A].太平御覽[M].北京：中華書局，1960.[5] 皇甫湜.皇甫持正文集[M].卷四.四部叢刊本.[6] 房玄齡等.晉書·司馬彪傳[M].北京：中華書局，1974.[7] Chester.The Rise of British Industrial Society[M].Longman, 1982.以例[6]、[7]為例，其隨文夾注格式分別為： [6]（p.4142.）、[7]（p.289.）。

多次引用同一本書中的材料，隨文夾注中一律采用第一次出現的序號。例如：第一次引用[7]中材料時，夾注為“[7]（p289）”；第二次引用[7]中材料時，夾注為“[7]（p163）”。多種材料說明一個問題，在隨文夾注中則按次序列出，例：“[4]（p×）；[5]（p×）”。

（二）期刊文章

[序號]主要責任者.文獻題名[J].刊名，年，卷（期）.例：

[8] 李醒民.哲學不是敲門磚和搖錢樹[J].學術界，2000，（1）.隨文夾注格式： [8]（p206）。

（三）論文集中的析出文獻

[序號]析出文獻主要責任者.析出文獻題名[A].原文獻主要責任者（任選）.原文獻題名[C].出版地：出版者，出版年.例：

[9] 王旭.美國三大城市與美國現代區域經濟結構[A].中國美國史研究學會.美國現代化歷史經驗[C].北京：東方出版社，1994.隨文夾注格式：[9]（p183）。

（四）報紙文章

[序號]主要責任者.文獻題名[N].報紙名，出版日期（版次）.例：

[10]楊玉圣.把書評當作學問來做[N].中華讀書報，1996-10-09（2）.（五）電子文獻

[序號]主要責任者.電子文獻題名[電子文獻及載體類型標識].電子文獻的出處或可獲得地址，發表或更新日期/引用日期.例：

[11]王明亮.關于中國學術期刊標準化數據庫系統工程的進展[EB/CD].http://,1998-08-16/1998-10-04.報紙文章和電子文獻在隨文夾注中直接以序號標出，而省略“（p×）”著錄項。

（六）各種未定義類型的文獻

[序號]主要責任者.文獻題名[Z].出版地：出版者，出版年.例：

[12]何曉明.降落民間——21世紀中國歷史學走向管窺（第十一屆全國史學理論研討會論文）[Z].武漢：湖北大學中國文化研究院，2000.二、參考文獻與注釋的區別

參考文獻是作者寫作論著時所參考的文獻書目，集中列于文末；注釋則是作者對論著正文中某一特定內容的進一步解釋或補充說明，列于該頁地腳（以腳注形式標出）。參考文獻序號用方括號標注，注釋序號則用數字加圓圈標注，位于標點符號之后；若是直接引文，則位于后引號之后。

附1：參考文獻類型及其標識

參考文獻 專著 論文集 析出文獻 報紙文章 期刊文章 學位論文 報 告

文獻類型標識 M C A N J D R 無法根據上述分類的文獻，其標識碼一律用“Z”表示。

附2：電子文獻的載體類型及其標識（[文獻類型標識/載體類型標識]）

電子文獻載體類型：磁帶（magnetic tape）——MT；磁盤（disk）——DK；光盤（CD-ROM）——CD；聯機網絡（online）——OL。按下列格式表示包括了文獻載體類型的參考文獻類型標識：

[DB/OL]——聯機網上數據庫（database online）

[DB/MT]——磁帶數據庫（database on magnetic tape）

[M/CD]——光盤圖書（monograph on CD-ROM）

[CP/DK]——磁盤軟件（computer program on disk）

[J/OL]——網上期刊（serial online）

[EB/OL]——網上電子公告（electronic bulletin online）

第五篇：C# 注釋規范

C# 注釋（Comment）規范

注釋規范包括：模塊（類）注釋規范、類的屬性、方法注釋規范、代碼間注釋

1.模塊（類）注釋規范

模塊開始必須以以下形式書寫模塊注釋：

///

///

2.類屬性注釋規范

在類的屬性必須以以下格式編寫屬性注釋：

///

3.方法注釋規范

在類的方法聲明前必須以以下格式編寫注釋

///

"><參數說明> /// ///<對方法返回值的說明，該說明必須明確說明返回的值代表什么含義> ///

4.代碼間注釋規范

代碼間注釋分為單行注釋和多行注釋：

單行注釋： //<單行注釋>

多行注釋： /*多行注釋1 多行注釋2 多行注釋3*/

代碼中遇到語句塊時必須添加注釋（if,for,foreach,……）,添加的注釋必須能夠說明此語句塊的作用和實現手段（所用算法等等）。

詳細介紹見：

http://