第一篇：程序代碼注釋編寫規(guī)范

程序代碼注釋編寫規(guī)范

為提高控制程序的閱讀性與可理解性，現制定相關代碼程序代碼注釋編寫的編寫規(guī)范。一般情況下，源程序有效注釋量必須在20％以上，注釋的原則是有助于對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準確、易懂、簡潔。常規(guī)注釋有以下兩種方式。

單行:以“//”符號開始，任何位于該符號之后的本行文字都視為注釋。

多行:以“/*”符號開始，以“*/”結束。任何介于這對符號之間的文字都視為注釋。

一、說明性文件

說明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應進行注釋，注釋必須列出：版權說明、版本號、生成日期、作者、內容、功能、與其它文件的關系、修改日志等，頭文件的注釋中還應有函數功能簡要說明。

示例：下面這段頭文件的頭注釋比較標準，當然，并不局限于此格式，但上述信息建議要包含在內。

/************************************************* COPYRIGHT(C), MicTiVo International.Co., Ltd.File NAME: // 文件 Author: Version: Date:

// 作者、版本及完成日期

DESCRIPTION: // 用于詳細說明此程序文件完成的主要功能，與其他模塊

// 或函數的接口，輸出值、取值范圍、含義及參數間的控

// 制、順序、獨立或依賴等關系 Others:

// 其它內容的說明

Function List: // 主要函數列表，每條記錄應包括函數名及功能簡要說明 1....History: // 修改歷史記錄列表，每條修改記錄應包括修改日期、修改

// 者及修改內容簡述 1.Date: Author: Modification: 2...*************************************************/

二、源文件頭

源文件頭部應進行注釋，列出：版權說明、版本號、生成日期、作者、模塊目的/功能、主要函數及其功能、修改日志等。

示例：下面這段源文件的頭注釋比較標準，當然，并不局限于此格式，但上述信息建議要包含在內。

/************************************************************ COPYRIGHT(C), MicTiVo International.Co., Ltd.FileName: Author: Version : Date: DESCRIPTION: // 模塊描述，描述本文件的內容、功能、內部各部分之間的關系及

//本文件與其它文件關系等 Version:

// 版本信息

Function List:

// 主要函數及其功能 1.-------History:

// 歷史修改記錄

**********************************************************/

三、函數

函數頭部應進行注釋，列出：函數的目的/功能、輸入參數、輸出參數、返回值、調用關系（函數、表）等。

示例：下面這段函數的注釋比較標準，當然，并不局限于此格式，但上述信息建議要包含在內。

/************************************************* Function:

// 函數名稱

DESCRIPTION: // 函數功能、性能等的描述 Calls:

// 被本函數調用的函數清單 Called By:

// 調用本函數的函數清單

Table Accessed: // 被訪問的表（此項僅對于牽扯到數據庫操作的程序）Table Updated: // 被修改的表（此項僅對于牽扯到數據庫操作的程序）Input:

// 輸入參數說明，包括每個參數的作

// 用、取值說明及參數間關系。OUTPUT:

// 對輸出參數的說明。Return:

// 函數返回值的說明 Others:

// 其它說明

*************************************************/

四、變量寄存器

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

Unsigned char receive_floag;//接收標志；

/* 0—接收失敗, 1—接收成功, 2—…….*/

/*

receive _process()

*/

//調用函數

Unsigned char receive_data[10];//數據接收存儲器；

/*在 receive _bit()中對其賦值*/

//調用函數

五、控制寄存器

在對控制器控制寄存器進行操作時，需注明該寄存器功能，配置參數作用，以及配置時的注意事項等的說明。示例：（PIC單片機定時器控制）void time0_init(void){ T0CON=0X09;

//設定TMR0工作于16位定時器方式,內部時鐘,不分頻 INTCON=INTCON|0X20;//TMR0中斷允許

INTCON=INTCON&0Xfb;//清除TMR0的中斷標志

INTCON=INTCON|0xc0;//* 開總中斷、開外圍接口中斷

TMR0H= 0xaa;

TMR0L= 0xaa;}

// 對TMR0寫入初值.注意:與溢出中斷寫初值不同

第二篇：C語言 程序代碼編寫規(guī)范

C語言 程序代碼編寫規(guī)范

（初級程序員 討論版）

前言

一個好的程序編寫規(guī)范是編寫高質量程序的保證。清晰、規(guī)范的源程序不僅僅是方便閱讀，更重要的是能夠便于檢查錯誤，提高調試效率，從而最終保證軟件的質量和可維護性。

說明

此文擋還在完善改進中，如有不足，歡迎指正。本文檔主要適用于剛剛開始接觸編程的初學者。

對于具有一定工程項目開發(fā)經驗的程序員，建議學習C語言程序代碼編寫規(guī)范—高級版。

目錄 代碼書寫規(guī)范 2 注釋書寫規(guī)范 3 命名規(guī)范內容代碼書寫規(guī)范

1.1函數定義

每個函數的定義和說明應該從第1列開始書寫。函數名（包括參數表）和函數體的花括號（“{”和“}”）應該各占一行。在函數體結尾的括號（“}”）后面應該加上注釋，注釋中應該包括函數名，這樣比較方便進行括號配對檢查，也可以清晰地看出來函數是否結束。

范例1：函數的聲明

void matMyFunction(int n){ …… } /* matMyFunction*/ 1.2空格的使用

使用空格分割所有演算符號和操作數。

這條規(guī)則的例外是“->”,““.”, “()”和“[]”，這些操作符和操作數之間不空格。當需要把一個程序行的內容分成幾行寫時，操作符號應該放在行末，而不是下一行的開頭。

1.3縮進的設置

代碼書寫應該遵從結構化的要求，采用縮進的格式。最小縮進量為4個空格，整個文件內部應該統(tǒng)一，不要混用Tab鍵和4個空格這兩種情況，因為不同的編輯器對Tab鍵的處理方法不同。

1.4折行的使用

每行的長度不要超過80個字符，當程序行太長時，應該分行書寫。分行時應該按照自然的邏輯關系進行，例如：不要把一個簡單的邏輯判斷寫在兩行上。

分行后的縮進應該按照程序的邏輯關系進行對齊。例如：參數表折行后，下面的行應該在參數表左括號的下方。

范例2：折行的格式dwNewShape = matAffineTransform(coords, translation，rotation);

if(((new_shape.x > left_border)&&

(new_shape.x < right_border))&&

((new_shape.y > bottom_border)&&

(new_shape.y < top_border))){

draw(new_shape);}

1.5嵌套語句（語句塊）的格式

對于嵌套式的語句--即語句塊（如，if、while、switch等）應該包括在花括號中?；ɡㄌ柕淖罄ㄌ枒搯为氄家恍?，并與關鍵字對齊。建議即使語句塊中只有一條語句，也應該使用花括號包括，這樣可以使程序結構更清晰，也可以避免出錯。建議對比較長的塊，在末尾的花括號后加上注釋以表明該語言塊結束。

范例3：嵌套語句格式 if(value < max){

if(value!= 0)

{

func(value);

} } } else {

error(“The value is too big.”);} /* if(value < max)*/ 注釋書寫規(guī)范

注釋必須做到清晰，準確地描述內容。對于程序中復雜的部分必須有注釋加以說明。注釋量要適中，過多或過少都易導致閱讀困難。

2.1注釋風格

語言中使用一組（/* … */）作為注釋界定符。注釋內容盡量用英語方式表述。

注釋的基本樣式參考范例4。

注釋應該出現在要說明的內容之前，而不應該出現在其后。

除了說明變量的用途和語言塊末尾使用的注釋，盡量不使用行末的注釋方式。

范例4：幾種注釋樣式

/*

* ************************************************* 強調注釋

* ************************************************ */ /* * 塊注釋 */

/* 單行注釋 */

int i;/*行末注釋*/ 2.2何時需要注釋

如果變量的名字不能完全說明其用途，應該使用注釋加以說明。

如果為了提高性能而使某些代碼變得難懂，應該使用注釋加以說明。對于一個比較長的程序段落，應該加注釋予以說明。如果設計文檔中有流程圖，則程序中對應的位置應該加注釋予以說明。

如果程序中使用了某個復雜的算法，建議注明其出處。

如果在調試中發(fā)現某段落容易出現錯誤，應該注明。命名規(guī)范

3.1常量、變量命名

用#define定義的符號常量全部采用大寫。

變量命名的基本原則：

可以選擇有意義的英文（小寫字母）組成變量名，使人看到該變量就能大致清 楚其含義。

不要使用人名、地名和漢語拼音。

如果使用縮寫，應該使用那些約定俗成的，而不是自己編造的。

多個單詞組成的變量名，每個單詞的首字母應該大寫。如：dwUserInputValue。

3.2函數命名

函數命名原則與變量命名原則基本相同。對于初學者，函數命名可以采用 “FunctionName”的形式。

第三篇：學術論文注釋規(guī)范

學術論文注釋規(guī)范

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

參考文獻按在正文中出現的先后次序列于文末，以“參考文獻：”（左頂格）作為標識。參考文獻的序號左頂格，并用數字加方括號表示，如[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] 王旭.美國三大城市與美國現代區(qū)域經濟結構[A].中國美國史研究學會.美國現代化歷史經驗[C].北京：東方出版社，1994.隨文夾注格式：[9]（p183）。

（四）報紙文章

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

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

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

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

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

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

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

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

附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）

第四篇：參考文獻及注釋規(guī)范

一、基本概念

（1）“注釋”指作者進一步解釋自己所要表達的意思，注釋安排在當頁頁腳，用帶圈數字表示序號，如注①、注②等，注釋的序號與文中序號一一對應。

（2）“參考文獻”指作者引文所注的出處，一律放在論文尾末，文中設序號 [1]，參考文獻的序號與文中序號一一對應。頁碼置于文中序號之后，例： [1]（P12）。

（3）“參考文獻”也指雖未直接引述別人的話、但參考了別人著作和論文的意思，應在段中或段末設序號 [1]，并在文末注明。本項與第2項不必分列，交叉排序即可。文末的序號與文中序號一一對應。此種情況可以不注明頁碼。

（4）同一參考文獻多次被引用，文末只標一個序號，文中應多次出現同一序號，在文中序號后加圓括號，注明所引文獻的不同頁碼或篇名。

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

二、中文參考文獻及注釋規(guī)范

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

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

引文的起止頁碼以隨文以夾注的形式、用6號宋體標出，其格式為：[序號]（p×）。各類參考文獻及其在正文中夾注的格式及示例如下：

1、專著、論文集、學位論文、報告

[序號]主要責任者.文獻題名[文獻類型標識].出版地：出版者，出版年.[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×）”。

2、期刊文章

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

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

3、論文集中的析出文獻

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

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

4、報紙文章

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

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

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

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

6、各種未定義類型的文獻 [序號]主要責任者.文獻題名[Z].出版地：出版者，出版年.例：

[12]何曉明.降落民間——21世紀中國歷史學走向管窺（第十一屆全國史學理論研討會論文）[Z].武漢：湖北大學中國文化研究院，2000.三、英文參考文獻及注釋規(guī)范

英文參考文獻Bibliography（Bibliography使用“Times New Roman”字體，小四號，加粗，后面不加任何標點符號。）

1.專著：

1)基本格式（請嚴格注意標點符號）：作者的姓名（英文作者的姓，名）.年份.書名（斜體）.出版地:出版商.如果同一作者兩本以上同年出版的參考書，在年份后用a，b，c 等標出； 如有第二行，則須縮進4個英文字符。例：

Chomsky, N.1981a.Lectures on government and binding.Dordrecht: Foris.Chomsky, N.1981b.Theory of markedness in generative grammar.Pisa, Italy: Scuola Normale Superiore.2)書的主編（格式：各項信息的排列順序基本同上，在主編姓名后加ed.）：

例：Hall, David, ed.1981.The Oxford book of American literary anecdotes.New York: OUP.3)機構作者（格式：各項信息的排列順序基本同上）：

例：American library association.1983.Intellectual freedom manual.2nd ed.Chicago: ALA.4)翻譯著作（格式：各項信息的排列順序基本同上，加xx Trans.）：

例：Calvino, Ian.1986.The uses of literature.P.Creagh Trans.San Diego: Harcourt.2.文章：

1)期刊文章基本格式（請嚴格注意標點符號）：作者姓名.年份.篇名.刊名（要斜體）.刊物的卷號和期號:文章的起止頁碼.例：

Boling, D.1965.The atomization of meaning.Language 41:555-573.2)論文集中的文章基本格式（請嚴格注意標點符號）：作者姓名.年份.篇名.論文集作者姓名.eds.論文集名稱（要斜體）.出版地:出版商.文章的起止頁碼.例：

Peters, M & T.B.Stephen.1986.Interaction routines as cultural influences upon language acquisition.In Schieffelin, B.B.& E.Ochs, eds.Language Socialization Across Cultures.Cambridge: CUP, 80-96.附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# 注釋規(guī)范

C# 注釋（Comment）規(guī)范

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

1.模塊（類）注釋規(guī)范

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

///

///

2.類屬性注釋規(guī)范

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

///

3.方法注釋規(guī)范

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

///

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

4.代碼間注釋規(guī)范

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

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

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

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

詳細介紹見：

http://