【實訓】C語言編碼規範表

目的	指導分佈式服務器C語言程序開發
針對語言	C語言
制定者	XXX
制定時間	2011年10月8日
項目	規範內容	備註
程序文件頭說明	/******************************************************* * Program Assignment : 程序文件編號 * Author:             作者姓名 * Date:               程序開始編寫時間 * Description:         程序文件整體的簡短描述 *******************************************************/	在所有源程序文件開頭的描述部分。
內容列表	/******************************************************* * Source code in : 源程序文件路徑 * Whole Value List : 全局變量列表 * Function List: *    functionName1 *    functionName2 *    functionName3 *******************************************************/	提供一個所有內容的列表總結，緊跟着“程序文件頭說明”
函數或方法註釋頭	/******************************************************* * Function Name: PrintSth * Purpose: 將輸入的字符創打印在屏幕上 * Params : *    @char *inStr 將要輸出打印到屏幕上的字符串。 * Return: 返回一個整型量，0表示打印失敗，1表示打印成 * Limitation: 輸入的inStr字符串不得爲空，長度不得超過1000 *******************************************************/ int PrintSth(char *inStr) { … }	描述程序時如何應用的。提供聲明格式，參數類型和參數限制
變量命名規範	l 變量命名不能使用單個字母。 l 使用英文單詞，理解上有歧義的單詞，需要在變量聲明是給出註釋說明。 l 多個單詞構成的變量名稱，除了第一個單詞外，其他單詞首字母大寫，其他字母小寫。包括參數變量。 l 全局變量，所有單詞首字母大寫。其他字母小寫。 好的例子： int strLength; int indexI;  /*用作 for 循環的下標*/ 壞的例子：    int l, I;
常量命名規範	l 常量命名需要使用英文單詞。 l 所有字母大寫。 l 單詞與單詞之間用下劃線分割 例如：    #define MAX_LINE 100
函數命名規範	l 使用英文單詞命名。 l 所有單詞首字母大寫。 l 單詞之間沒有特殊分隔符。
空白行	l 在寫程序時要給出足夠多的空行，避免程序看起來過於擁擠。 l 買一個程序部分之間都要用一個空行進行分割。
縮進規範	l 大括號匹配。 l 每增加一層大括號，其間的內容統一增加一個tab的縮進。