編程語言注釋

㈠ c語言程序注釋

C語言編程規范-注釋

規則:
1：一般情況下，源程序有效注釋量必須在20％以上。
說明：注釋的原則是有助於對程序的閱讀理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須准確、易懂、簡潔。
2：說明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應進行注釋，注釋必須列出：版權說明、版本號、生成日期、作者、內容、功能、與其它文件的關系、修改日誌等，頭文件的注釋中還應有函數功能簡要說明。
示例：下面這段頭文件的頭注釋比較標准，當然，並不局限於此格式，但上述信息建議要包含在內。
/*************************************************
Copyright (C), 1988-1999, Tech. Co., Ltd.
File name: // 文件名
Author:
Version:
Date: // 作者、版本及完成日期
Description: // 用於詳細說明此程序文件完成的主要功能，與其他模塊
// 或函數的介面，輸出值、取值范圍、含義及參數間的控
// 制、順序、獨立或依賴等關系
Others: // 其它內容的說明
Function List: // 主要函數列表，每條記錄應包括函數名及功能簡要說明
1. ....
History: // 修改歷史記錄列表，每條修改記錄應包括修改日期、修改
// 者及修改內容簡述
1. Date:
Author:
Modification:
2. ...
*************************************************/
3：源文件頭部應進行注釋，列出：版權說明、版本號、生成日期、作者、模塊目的/功能、主要函數及其功能、修改日誌等。
示例：下面這段源文件的頭注釋比較標准，當然，並不局限於此格式，但上述信息建議要包含在內。
/************************************************************
Copyright (C), 1988-1999, Tech. Co., Ltd.
FileName: test.cpp
Author:
Version :
Date:
Description: // 模塊描述
Version: // 版本信息
Function List: // 主要函數及其功能
1. -------
History: // 歷史修改記錄
<author> <time> <version > <desc>
David 96/10/12 1.0 build this moudle
***********************************************************/
說明：Description一項描述本文件的內容、功能、內部各部分之間的關系及本文件與其它文件關系等。History是修改歷史記錄列表，每條修改記錄應包括修改日期、修改者及修改內容簡述。

4：函數頭部應進行注釋，列出：函數的目的/功能、輸入參數、輸出參數、返回值、調用關系（函數、表）等。
示例：下面這段函數的注釋比較標准，當然，並不局限於此格式，但上述信息建議要包含在內。

/*************************************************
Function: // 函數名稱
Description: // 函數功能、性能等的描述
Calls: // 被本函數調用的函數清單
Called By: // 調用本函數的函數清單
Table Accessed: // 被訪問的表（此項僅對於牽扯到資料庫操作的程序）
Table Updated: // 被修改的表（此項僅對於牽扯到資料庫操作的程序）
Input: // 輸入參數說明，包括每個參數的作
// 用、取值說明及參數間關系。
Output: // 對輸出參數的說明。
Return: // 函數返回值的說明
Others: // 其它說明
*************************************************/

5：邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。
6：注釋的內容要清楚、明了，含義准確，防止注釋二義性。
說明：錯誤的注釋不但無益反而有害。
7：避免在注釋中使用縮寫，特別是非常用縮寫。
說明：在使用縮寫時或之前，應對縮寫進行必要的說明。
8：注釋應與其描述的代碼相近，對代碼的注釋應放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放於上方則需與其上面的代碼用空行隔開。
示例：如下例子不符合規范。

例1：
/* get replicate sub system index and net indicator */

repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
例2：
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
/* get replicate sub system index and net indicator */
應如下書寫
/* get replicate sub system index and net indicator */
repssn_ind = ssn_data[index].repssn_index;
repssn_ni = ssn_data[index].ni;
9：對於所有有物理含義的變數、常量，如果其命名不是充分自注釋的，在聲明時都必須加以注釋，說明其物理含義。變數、常量、宏的注釋應放在其上方相鄰位置或右方。
示例：
/* active statistic task number */
#define MAX_ACT_TASK_NUMBER 1000

#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */
10：數據結構聲明(包括數組、結構、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對數據結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋放在此域的右方。
示例：可按如下形式說明枚舉/數據/聯合結構。
/* sccp interface with sccp user primitive message name */
enum SCCP_USER_PRIMITIVE
{
N_UNITDATA_IND, /* sccp notify sccp user unit data come */
N_NOTICE_IND, /* sccp notify user the No.7 network can not */
/* transmission this message */
N_UNITDATA_REQ, /* sccp user's unit data transmission request*/
};
11：全局變數要有較詳細的注釋，包括對其功能、取值范圍、哪些函數或過程存取它以及存取時注意事項等的說明。
示例：
/* The ErrorCode when SCCP translate */
/* Global Title failure, as follows */ // 變數作用、含義
/* 0 － SUCCESS 1 － GT Table error */
/* 2 － GT error Others － no use */ // 變數取值范圍
/* only function SCCPTranslate() in */
/* this moal can modify it, and other */
/* mole can visit it through call */
/* the function GetGTTransErrorCode() */ // 使用方法
BYTE g_GTTranErrorCode;
12：注釋與所描述內容進行同樣的縮排。
說明：可使程序排版整齊，並方便注釋的閱讀與理解。
示例：如下例子，排版不整齊，閱讀稍感不方便。
void example_fun( void )
{
/* code one comments */
CodeBlock One

/* code two comments */
CodeBlock Two
}

應改為如下布局。
void example_fun( void )
{
/* code one comments */
CodeBlock One

/* code two comments */
CodeBlock Two
}
13：將注釋與其上面的代碼用空行隔開。
示例：如下例子，顯得代碼過於緊湊。
/* code one comments */
program code one
/* code two comments */
program code two

應如下書寫
/* code one comments */
program code one

/* code two comments */
program code two
14：對變數的定義和分支語句（條件分支、循環語句等）必須編寫注釋。
說明：這些語句往往是程序實現某一特定功能的關鍵，對於維護人員來說，良好的注釋幫助更好的理解程序，有時甚至優於看設計文檔。
15：對於switch語句下的case語句，如果因為特殊情況需要處理完一個case後進入下一個case處理，必須在該case語句處理完、下一個case語句前加上明確的注釋。
說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句。
示例（注意斜體加粗部分）：
case CMD_UP:
ProcessUp();
break;

case CMD_DOWN:
ProcessDown();
break;

case CMD_FWD:
ProcessFwd();

if (...)
{
...
break;
}
else
{
ProcessCFW_B(); // now jump into case CMD_A
}

case CMD_A:
ProcessA();
break;

case CMD_B:
ProcessB();
break;

case CMD_C:
ProcessC();
break;

case CMD_D:
ProcessD();
break;
...
建議:
1：避免在一行代碼或表達式的中間插入注釋。
說明：除非必要，不應在代碼或表達中間插入注釋，否則容易使代碼可理解性變差。
2：通過對函數或過程、變數、結構等正確的命名以及合理地組織代碼的結構，使代碼成為自注釋的。
說明：清晰准確的函數、變數等的命名，可增加代碼可讀性，並減少不必要的注釋。
3：在代碼的功能、意圖層次上進行注釋，提供有用、額外的信息。
說明：注釋的目的是解釋代碼的目的、功能和採用的方法，提供代碼以外的信息，幫助讀者理解代碼，防止沒必要的重復注釋信息。
示例：如下注釋意義不大。
/* if receive_flag is TRUE */
if (receive_flag)

而如下的注釋則給出了額外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
4：在程序塊的結束行右方加註釋標記，以表明某程序塊的結束。
說明：當代碼段較長，特別是多重嵌套時，這樣做可以使代碼更清晰，更便於閱讀。
示例：參見如下例子。
if (...)
{
// program code

while (index < MAX_INDEX)
{
// program code
} /* end of while (index < MAX_INDEX) */ // 指明該條while語句結束
} /* end of if (...)*/ // 指明是哪條if語句結束
5：注釋格式盡量統一，建議使用"/* …… */"。
6：注釋應考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利准確的英文表達。
說明：注釋語言不統一，影響程序易讀性和外觀排版，出於對維護人員的考慮，建議使用中文。

㈡ c語言程序的注釋是以什麼開頭什麼結束

c語言程序中，單行注釋以//開頭，以行末結束；多行注釋以/開頭，以/結尾。

1、單行注釋：單行注釋以//開頭，以行末結束。編譯器會忽略//後面的任何文本，即使它是一段重要的代碼。單行注釋通常用於提供關於代碼的簡短說明或解釋。例如：//這是一個單行注釋，int x=5；//這里聲明了一個整數變數x並賦值為5。

3、嵌入式系統：C語言在嵌入式系統領域也占據主導地位，如智能設備、機器人、汽車電子等。C語言的簡潔性和可控性使得它成為嵌入式開發的理想選擇。

4、游戲開發：許多大型游戲都使用C語言作為主要的編程語言，如《魔獸世界》、《CS：GO》等。C語言的性能和靈活性使得它成為游戲開發的首選。

5、科學計算：C語言的高效性能和數值計算能力使其在科學計算領域非常適用，如天氣預報、數值分析、物理模擬等。

㈢ c語言注釋是什麼

注釋是語句這句話不全面，應該說注釋是注釋語句。

1、可以使用/*和*/分隔符來標注一行內的注釋，也可以標注多行的注釋。例如，在下列的函數原型中，省略號的意思是 open() 函數有第三個參數，它是可選參數。注釋解釋了這個可選參數的用法：

int open( const char *name, int mode, … /* int permissions */ )。

2、可以使用//插入整行的注釋，或者將源代碼寫成兩列分欄的格式，程序在左列，注釋在右列：

const double pi = 3.1415926536// pi是—個常量。

C語言是一門面向過程的計算機編程語言，與C++、C#、Java等面向對象編程語言有所不同。C語言的設計目標是提供一種能以簡易的方式編譯、處理低級存儲器、僅產生少量的機器碼以及不需要任何運行環境支持便能運行的編程語言。

C語言描述問題比匯編語言迅速、工作量小、可讀性好、易於調試、修改和移植，而代碼質量與匯編語言相當。C語言一般只比匯編語言代碼生成的目標程序效率低10%-20%。因此，C語言可以編寫系統軟體。