編程注釋實例

㈠ python中如何添加註釋

1. 單行注釋

Python編程語言的單行注釋常以#最初，單行注釋能夠作為獨自的一行放在被注釋代碼行之上，也能夠放在語句或許表達式之後。

實例：

# -*- coding: UTF-8 -*-

print ("hello world!"); #您好，國際

2. 多行注釋

Python中多行注釋運用三個單引號(’’’)或許三個雙引號(”””)來標記，而實際上這是多行字元串的書寫方法，並不是Python本身提倡的多行注釋方法。

實例：

'''

這是多行注釋，運用單引號。

這是多行注釋，運用單引號。

'''

"""

這是多行注釋，運用雙引號。

這是多行注釋，運用雙引號。

"""

3. 編碼注釋

在進行Python開發時，需進行編碼聲明，如選用UTF-8編碼，需在源碼上方進行 # -*- coding: UTF-8 -*- 聲明，從Python3開始，Python默許運用UTF-8編碼，所以Python3.x的源文件不需要特別聲明UTF-8編碼。

4. 平台注釋

如果需要使Python程序運行在Windows平台上，需在Python文件的上方加上 #!/usr/bin/python 注釋闡明。

關於Python中如何添加註釋，青藤小編就和您分享到這里了。如果您對python編程有濃厚的興趣，希望這篇文章可以為您提供幫助。如果您還想了解更多關於python編程的技巧及素材等內容，可以點擊本站的其他文章進行學習。

㈡ C語言中如何注釋

一般來講有兩種：
一是單行注釋：直接在該行需要注釋的地方加上"//"就行了。例如：
"int a,b;//這是一個注釋行"。那麼，"//"後面的部分"這是一個注釋行"就被注釋掉了，不起作用，但是"//"前面的「int a,b;"不受影響。
另外還有一種是多行同時注釋：
/*
int a,b;
int c,d;
*/
其中"/*"和"*/"起限定范圍的作用，該范圍內的語句都會被注釋掉，將不再起作用。當然，多行注釋也是可以用來單行注釋的

㈢ python代碼的注釋有幾種

python代碼的注釋有兩種。
一、python單行注釋符號(#)
python中單行注釋採用#開頭，示例：#thisisacomment。
二、批量、多行注釋符號
多行注釋是用三引號，例如：輸入''''''或者""""，將要注釋的代碼插在中間。

Python由荷蘭數學和計算機科學研究學會的吉多·范羅蘇姆於1990年代初設計，作為一門叫做ABC語言的替代品。Python提供了高效的高級數據結構，還能簡單有效地面向對象編程。
Python語法和動態類型，以及解釋型語言的本質，使它成為多數平台上寫腳本和快速開發應用的編程語言，隨著版本的不斷更新和語言新功能的添加，逐漸被用於獨立的、大型項目的開發。"

㈣ 「Python編程規范」為Python代碼添加註釋

功能要求

為Python代碼添加註釋，對Python程序代碼進行說明。

實例代碼

'''多行注釋開始

下面的代碼根據變數x的值計算y

注意代碼中使用縮進表示代碼塊

多行注釋結束'''

x = 5

if x > 100:

y = x * 5 - 1 # 單行注釋：x>100時執行該語句

else:

y = 0 # x <= 100時執行該語句

print(y) # 輸出y

運行結果

知識說明

注釋用於為程序添加說明性的文字，幫助程序員更好的閱讀和理解程序代碼。Python解釋器會忽略注釋的內容，即注釋的內容不會被Python解釋器執行。

Python注釋分為單行注釋和多行注釋。

單行注釋以符號「#」開始，當前行中符號「#」及其後的內容為注釋語句。單行注釋可以獨佔一行，也可放在語句末尾。 說明： 在Pycharm中使用「ctrl + /」可以添加/取消單行注釋。

多行注釋是用3個英文單引號「'''多行注釋文本'''」或3個雙引號「"""注釋文本"""」進行注釋。 注意： 由一對三個單引號或一對三個雙引號括起來的內容被認為是注釋，但不能由三個單引號和三個雙引號混合使用。

㈤ 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：注釋應考慮程序易讀及外觀排版的因素，使用的語言若是中、英兼有的，建議多使用中文，除非能用非常流利准確的英文表達。
說明：注釋語言不統一，影響程序易讀性和外觀排版，出於對維護人員的考慮，建議使用中文。