1 源文件頭部注釋
- 列出：版權、作者、編寫日期和描述。
- /*************************************************
- Copyright:bupt
- Author:
- Date:2010-08-25
- Description:描述主要實現的功能
- **************************************************/
每行不要超過80個字符的寬度。
2 函數頭部注釋
/功能、輸入參數、輸出參數、返回值、調用關系（函數、表）等。
- /*************************************************
- Function: // 函數名稱
- Description: // 函數功能、性能等的描述
- Calls: // 被本函數調用的函數清單
- Table Accessed: // 被訪問的表（此項僅對於牽扯到數據庫操作的程序）
- Table Updated: // 被修改的表（此項僅對於牽扯到數據庫操作的程序）
- Input: // 輸入參數說明，包括每個參數的作
- // 用、取值說明及參數間關系。
- Output: // 對輸出參數的說明。
- Return: // 函數返回值的說明
- Others: // 其它說明
- *************************************************/
3 數據結構聲明的注釋(包括數組、結構、類、枚舉等)
如果其命名不是充分自注釋的，必須加以注釋。對數據結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋放在此域的右方。
- /* 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*/
- };