1、變量定義
?部件名稱不超過40個字符,組成方式為A_B_C...。
?A部分表示前綴,B部分表示后綴。
?緊跟著一條下劃線“_”。
?A和B和…要有實際意義,具有一定的規(guī)律。
?項目的變量定義最好是用統(tǒng)一的命名方式,如果變量用每個漢語拼音開頭字母縮寫都用每個漢語拼音開頭字母縮寫(如:水池液位:SCYW或者SC_YW),用英語都用英語,盡量簡單化。個別不容易識別變量的要在歸檔中加以注釋說明;
?某些時候也可以用漢字來定義變量。
?變量的定義應(yīng)該用Excel文件保存一份完整的注釋,同項目文件一起備份。
2、函數(shù)定義
(1) 函數(shù)的命名規(guī)則
函數(shù)名=‘函數(shù)適用范圍代碼’ +‘f’+‘_’+‘函數(shù)功能描述’,其中函數(shù)的適用范圍代碼和意義如下:
g 全局函數(shù);
w 窗口函數(shù);
m 菜單函數(shù);
u 用戶對象函數(shù)。
例:檢查SQL語句執(zhí)行結(jié)果的全局用戶函數(shù)命名如下:gf_checksql()。
(2)初始化配置文件
初始化配置文件的命名必須與應(yīng)用的名稱一致,擴展名為.ini,例如:si.ini。用戶的可變環(huán)境信息都應(yīng)該保存在該文件中,關(guān)鍵信息加密保存(哈希函數(shù)),并且提供管理工具,而不是手工修改該文件。
3、程序規(guī)范
(1) 書寫格式
?用分層縮進的寫法顯示嵌套結(jié)構(gòu)的層次。
?在注釋段與程序段,以及不同邏輯的程序段之間插入空行。
?每行只寫一條語句,當需要滾動顯示時應(yīng)該分行書寫。
(2)流程控制
流程控制首先應(yīng)遵守語法規(guī)范,且用分層縮進的寫法突出顯示嵌套的層次結(jié)構(gòu),例如:
For i = 1 To 100
For j = 1 To 50
For k = 1 To 200
Matrix[i,j,k]=1
Next
Next
Next
(3)注釋及格式要求
注釋總是加在程序中需要概括性說明或不易令人理解或容易令人理解錯的地方。注釋語言應(yīng)簡練、易懂而又準確,所采用的語種首選是中文,如有輸入困難或特殊需求也可采用英文。
注釋原則:
a、函數(shù)或過程的注釋
?在函數(shù)頭部必須說明函數(shù)的功能和參數(shù)(值參、變參);
?在函數(shù)的主體部分,如算法復(fù)雜時,應(yīng)以注釋的方式對其算法結(jié)構(gòu)做出說明;
?函數(shù)申請全局資源且有可能導(dǎo)致資源緊張應(yīng)加以注明(如內(nèi)存和文件句柄等);
?函數(shù)有副作用一定以十分醒目的方式(如加!號等)注明。
b、語句的注釋
?應(yīng)對不易理解的分支條件表達式加注釋;
?不易理解的循環(huán),應(yīng)說明出口條件(有GOTO的程序還應(yīng)說明入口條件);
?過長的函數(shù)實現(xiàn),應(yīng)將其語句按實現(xiàn)的功能分段加以概括性說明。
c、制定對象的注釋
每個開發(fā)人員針對自己所制定的窗口、菜單、數(shù)據(jù)窗口、數(shù)據(jù)管道和用戶對象等添加注釋,要點是:
?標注對象的用途;
?標注對象的制定人員;
?標注時間或者修改時間。
具體格式參考示例如下:
示例1. 在窗口Open事件前應(yīng)說明
/* ======================================================= */
// 窗口中英文名稱:
// 窗口作用:
// 作者:
// 日期:
/* ======================================================= */
示例2. 在事件腳本(Script)之前應(yīng)說明
/* ======================================================= */
// 腳本作用:
// 輸入?yún)?shù)及數(shù)據(jù)類型:
// 返回參數(shù)及數(shù)據(jù)類型:
// 全局函數(shù)及其用途:
// 全局變量及其用途:
聯(lián)系客服