2011软考软件设计师：C语言代码规范问题(3)2

 　1.3.4 函数注释通常置于每函数或过程的开头部分，它应当给出函数或过程的整体说明对于理解程序本身具有引导作用。一般包括如下条目：

　　--模块标题。

　　--有关本模块功能和目的的说明。

　　--调用格式

　　--接口说明：包括输入、输出、返回值、异常。

　　--算法。如果模块中采用了一些复杂的算法。

　　例：

　　file：//(注释开头应和上一函数空两行)

　　(注释开头与上一函数最后一行间隔两行)

　　/

　　标题：assignmentComplete

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

　　格式：

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

　　输入：

　　int iCellId： MS所在的小区识别

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

　　Q/ECC/BJ 010-2001

　　int iServiceChannnelNum：MS所占的业务信道号码

　　输出：

　　char pszMSGData：指配完成消息数据

　　返回值： 0x00正常

　　异常：exception1异常情况1， exception2异常情况2

　　/

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

　　1.3.5 功能性注释嵌在源程序体中，用于描述其后的语句或程序段做什么工作，也就是解释下面要做什么，或是执行了下面的语句会怎么样。而不要解释下面怎么做，因为解释怎么做常常与程序本身是重复的。

　　例： /把 amount 加到 total中/

　　total = amount + total;

　　这样的注释仅仅是重复了下面的程序，对于理解它的工作并没有什么作用。而下面的注释，有助于读者理解。

　　/将每月的销售额amount加到年销售额total中/

　　total = amount + total;