真实的国产乱ⅩXXX66竹夫人,五月香六月婷婷激情综合,亚洲日本VA一区二区三区,亚洲精品一区二区三区麻豆

成都創(chuàng)新互聯網站制作重慶分公司

c語言函數描述注釋舉例,c語言中注釋的寫法

C語言里有哪些注釋方法

答:在用C語言編程時,常用的注釋方式有如下幾種:

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

(1)單行注釋 //…

(2)多行注釋 /*…*/

(3)條件編譯注釋 #if 0…#endif

拓展資料:

對于(1),注釋只能顯示在一行內,通常出現在一條語句的右邊或者上方,對于注釋符”//”,一個注釋里只要有多余2個’/’都可以。

對于(2),”/*…*/”不能嵌套使用,正如”if…else”中的”else”總是和隔它最近的”if”配對一樣,”/*”總是和離它最近的”*/”相配對。

針對(1)和(2)各自的缺陷,資深的程序員提出如(3)所示的注釋,該注釋的好處是能注釋大塊的程序,并且沒有嵌套的限制,也就是說在”#if 0…#endif”的”…”處可以有”//”或”/*…*/”這樣的注釋。

C語言的一個函數,誰能給逐句注釋一下

void Translate(void)

{

unsigned char data; //聲明data為無符號字符型變量

while((Fifo_Get(data))==0)//while循環(huán),滿足Fifo_Get(data)為真時進入循環(huán)(為取址符,傳輸data變量的存放地址給函數)

{

switch(stateRX) //多項選擇,

{

case RCV_FE: //當stateRX的值等于RCV_FE時執(zhí)行以下語句。(case的格式:case 常量 :。RCV_應該是通過在程序開頭#define RCV_FE ??得到的,??表示任何符號 )

if( data == 0xfe) //若data為0xfe(0x??表示十六進制數)時

stateRX++; //stateRX自增(相當于stateRX=stateRX+1;但執(zhí)行速度更快)

else //若前面的data == 0xfe條件不成立,則執(zhí)行以下語句

stateRX = RCV_FE; //賦值語句

break; //跳出switch,(若沒有這步,若case RCV_FE:成立將會一直執(zhí)行下去,忽略下面的case)

case RCV_EF: //同理

if( data == 0xef) //同理

else //同理

stateRX = RCV_FE; //同理

break; //同理

case RCV_ID: //同理

LRC = 0Xff; //同理

id = data; //同理

LRC ^= data; //。。。。。這句就。。。LRC和data的各相應位進行異或再賦值給LRC(異或:位運算,法則是必須不同,否則沒有,例子:1^1=0,1^0=1,0^0=0)

stateRX++; //同理

break; //同理

case RCV_LEN: //同理

len = data; //同理

LRC ^= data; //同理

stateRX++; //同理

break;//同理

case RCV_INSTRUCT://同理

cmd = data;//同理

LRC ^= data;//同理

paraindex = 0;//同理

if(len-2=0)//len-2=0的意思是先len-2再判斷l(xiāng)en-2是否小于等于零

stateRX=RCV_CHKSUM;//同理

else//同理

stateRX++; //同理

break; //同理

case RCV_PARA://同理

paratmp[paraindex++] = data;//將data賦值給paratmp[paraindex],然后paraindex自增;

LRC ^= data;//同理

if( paraindex = len-2)//同理

stateRX++; //同理

break;//同理

case RCV_CHKSUM://同理

if(LRC == data)//同理

Dispatch(); //函數Dispatch()

stateRX = RCV_FE; //同理

break; //同理

default://switch的末句,若以上case都不等于stateRX的值,則執(zhí)行default后面的語句,這里default后面是brake;,這兩句不要也可

break;

}

}

}不能說完,但希望能拿到這兩百塊

用C語言編寫幾個子函數(至少四個子函數),用主函數來調用實現其功能,并對函數進行注釋?

一、//調用函數事例

#includestdio.h

#includestring.h

二、//計算加法函數

int add(int a, int b)

{

return a+b;

}

三、//計算減法函數

int subtract(int a, int b)

{

return a-b;

}

四、//計算乘法函數

int multiply(int a, int b)

{

return a*b;

}

擴展資料:

函數作為另一個函數調用的實際參數出現。這種情況是把該函數的返回值作為實參進行傳送,因此要求該函數必須是有返回值的。例如: printf("%d",max(x,y)); 即是把max調用的返回值又作為printf函數的實參來使用的。在函數調用中還應該注意的一個問題是求值順序的問題。

參考資料來源:百度百科-函數調用

C語言程序注釋

C語言編程規(guī)范-注釋

規(guī)則:

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:注釋應與其描述的代碼相近,對代碼的注釋應放在其上方或右方(對單條語句的注釋)相鄰位置,不可放在下面,如放于上方則需與其上面的代碼用空行隔開。

示例:如下例子不符合規(guī)范。

例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 modual can modify it, and other */

/* module 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:對變量的定義和分支語句(條件分支、循環(huán)語句等)必須編寫注釋。

說明:這些語句往往是程序實現某一特定功能的關鍵,對于維護人員來說,良好的注釋幫助更好的理解程序,有時甚至優(yōu)于看設計文檔。

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:注釋格式盡量統(tǒng)一,建議使用"/* …… */"。

6:注釋應考慮程序易讀及外觀排版的因素,使用的語言若是中、英兼有的,建議多使用中文,除非能用非常流利準確的英文表達。

說明:注釋語言不統(tǒng)一,影響程序易讀性和外觀排版,出于對維護人員的考慮,建議使用中文。


當前標題:c語言函數描述注釋舉例,c語言中注釋的寫法
當前地址:http://weahome.cn/article/dsssdjp.html

其他資訊

在線咨詢

微信咨詢

電話咨詢

028-86922220(工作日)

18980820575(7×24)

提交需求

返回頂部