int nArray[ARRAY_SIZE];
unsigned char uchByte;
char szName[ ];
char *pszName = szName;
}
(11)有些詞頭(如p和u)可以和其它詞頭組合。
例:WDOG_ID wdId;
WDOG_ID g_wdId; /*全局watchdog Id,故以g_開頭*/
1.1.2名字的長度一般不要過長或過短。過長的名字會增加工作量,使程序邏輯流程變得模糊;過短的名字無法表達符號的實際意義。約定長度范圍:3-31;
1.2數據和函數說明
1.2.1數據說明次序應當規范化,使數據屬性容易查找,也有利于測試、排錯和維護。說明的先后次序應固定,應按邏輯功能排序,邏輯功能塊內建議采用下列順序:整型說明、實型說明、字符說明、邏輯量說明。
1.2.2如果設計了一個復雜的數據結構,應當通過注釋對其變量的含義、用途進行說明。
1.2.3在函數的聲明中使用異常聲明。
如:void f() throw(toobig, toosmall, divzero);
在聲明一個函數時,將它所拋出的異常列出,便于函數的使用者了解可能會發生哪些異常。
1.3 程序注釋
1.3.1程序注釋是程序員與日后的程序讀者之間通信的重要手段之一,注釋分為文件注釋、函數注釋和功能注釋。
1.3.2正規程序的注釋應注意:
——注釋行的數量占到整個源程序的1/3到1/2。
1.3.3文件注釋位于整個源程序的最開始部分,注釋后空兩行開始程序正文。它包括:
——程序標題。
——目的、功能說明。
——文件作者、最后修改日期等說明。
例:
./********************************************************************
(空一行)
標題: Demo.c
功能: 測試VxWorks的各種系統調用.
說明:
該程序測試各種VxWorks的系統調用函數。包括任務(taks)的創建、掛起及任務間通過信號燈實現同步,通過消息隊列進行通訊。
程序創建了兩個任務:一個高優先級的任務和一個低優先級的任務。兩個任務間通過一個二進制的信號燈進行同步,通過消息隊列進行通訊。
當前版本: x.x
修改信息: 2000.06.05 John, Initial Version
2000.07.05 Tom, Bug xxxx fixed
**************************************************************/
(空2行,開始程序正文)
1.3.4 函數注釋通常置于每函數或過程的開頭部分,它應當給出函數或過程的整體說明對于理解程序本身具有引導作用。一般包括如下條目:
——模塊標題。
——有關本模塊功能和目的的說明。
——調用格式
——接口說明:包括輸入、輸出、返回值、異常。
——算法。如果模塊中采用了一些復雜的算法。
例:
file://(注釋開頭應和上一函數空兩行)
文章來源于領測軟件測試網 http://www.kjueaiud.com/