2011軟考軟件設(shè)計師：C語言代碼規(guī)范問題(3)

　　1.3.4 函數(shù)注釋通常置于每函數(shù)或過程的開頭部分，它應(yīng)當(dāng)給出函數(shù)或過程的整體說明對于理解程序本身具有引導(dǎo)作用。一般包括如下條目：

　　——模塊標(biāo)題。

　　——有關(guān)本模塊功能和目的的說明。

　　——調(diào)用格式

　　——接口說明：包括輸入、輸出、返回值、異常。

　　——算法。如果模塊中采用了一些復(fù)雜的算法。

　　例：

　　file：//(注釋開頭應(yīng)和上一函數(shù)空兩行)

　　(注釋開頭與上一函數(shù)最后一行間隔兩行)

　　/

　　標(biāo)題：assignmentComplete

　　功能：BSC=%26gt;MSC消息生成函數(shù)，生成assignment_complete指配完成消息(BSMAP消息) .

　　格式：

　　int assignmentComplete(int iCellId， int iServiceChannnelNum， char pszMSGData) throw(exception1， exception2)

　　輸入：

　　int iCellId： MS所在的小區(qū)識別

　　iCellId取值：0x00-——0xff .4.

　　Q/ECC/BJ 010—2001

　　int iServiceChannnelNum：MS所占的業(yè)務(wù)信道號碼

　　輸出：

　　char pszMSGData：指配完成消息數(shù)據(jù)

　　返回值： 0x00正常

　　異常：exception1異常情況1， exception2異常情況2

　　/

　　( 注釋后直接開始程序正文，不空行。)

　　1.3.5 功能性注釋嵌在源程序體中，用于描述其后的語句或程序段做什么工作，也就是解釋下面要做什么，或是執(zhí)行了下面的語句會怎么樣。而不要解釋下面怎么做，因為解釋怎么做常常與程序本身是重復(fù)的。

　　例： /把 amount 加到 total中/

　　total = amount + total;

　　這樣的注釋僅僅是重復(fù)了下面的程序，對于理解它的工作并沒有什么作用。而下面的注釋，有助于讀者理解。

　　/將每月的銷售額amount加到年銷售額total中/

　　total = amount + total;

　　2011年上半年軟考報名時間預(yù)測：2011年3月

　　2010年下半年軟考成績查詢時間及方式匯總

　　軟考軟件設(shè)計師歷年真題匯總(2007年-2010年)

　　2011軟考軟件設(shè)計師：C語言代碼規(guī)范問題匯總