這篇文章主要介紹“如何理解VBScript編碼約定”,在日常操作中,相信很多人在如何理解VBScript編碼約定問題上存在疑惑,小編查閱了各式資料,整理出簡(jiǎn)單好用的操作方法,希望對(duì)大家解答”如何理解VBScript編碼約定”的疑惑有所幫助!接下來,請(qǐng)跟著小編一起來學(xué)習(xí)吧!

編碼約定是幫助您使用 Microsoft Visual Basic Scripting Edition 編寫代碼的一些建議。編碼約定包含以下內(nèi)容:
對(duì)象、變量和過程的命名約定
注釋約定
文本格式和縮進(jìn)指南
使用一致的編碼約定的主要原因是使腳本或腳本集的結(jié)構(gòu)和編碼樣式標(biāo)準(zhǔn)化,這樣代碼易于閱讀和理解。使用好的編碼約定可以使源代碼明白、易讀、準(zhǔn)確,更加直觀且與其他語言約定保持一致。
VBScript 的早期版本不允許創(chuàng)建用戶自定義常數(shù)。如果要使用常數(shù),則常數(shù)以變量的方式實(shí)現(xiàn),且全部字母大寫以和其他變量區(qū)分。常數(shù)名中的多個(gè)單詞用下劃線 (_) 分隔。例如:
USER_LIST_MAX NEW_LINE
這種標(biāo)識(shí)常數(shù)的方法依舊可行,但您還可以選擇其他方案,用 Const 語句創(chuàng)建真正的常數(shù)。這個(gè)約定使用大小寫混合的格式,并以“con”作為常數(shù)名的前綴。例如:
conYourOwnConstant
為提高易讀和一致性,請(qǐng)?jiān)?VBScript 代碼中使用以下變量命名約定:
| 子類型 | 前綴 | 示例 |
|---|---|---|
| Boolean | bln | blnFound |
| Byte | byt | bytRasterData |
| Date (Time) | dtm | dtmStart |
| Double | dbl | dblTolerance |
| Error | err | errOrderNum |
| Integer | int | intQuantity |
| Long | lng | lngDistance |
| Object | obj | objCurrent |
| Single | sng | sngAverage |
| String | str | strFirstName |
變量應(yīng)定義在盡量小的作用域中。VBScript 變量的作用域如下所示:
| 作用域 | 聲明變量處 | 可見性 |
|---|---|---|
| 過程級(jí) | 事件、函數(shù)或子過程。 | 在聲明變量的過程中可見。 |
| Script 級(jí) | HTML 頁面的 HEAD 部分,任何過程之外。 | 在腳本的所有過程中可見。 |
隨著腳本代碼長(zhǎng)度的增加,有必要快速區(qū)分變量的作用域。在類型前綴前面添加一個(gè)單字符前綴可以實(shí)現(xiàn)這一點(diǎn),而不致使變量名過長(zhǎng)。
| 作用域 | 前綴 | 示例 |
|---|---|---|
| 過程級(jí) | 無 | dblVelocity |
| Script 級(jí) | s | sblnCalcInProgress |
變量名或過程名的主體應(yīng)使用大小寫混合格式,并且盡量完整地描述其目的。另外,過程名應(yīng)以動(dòng)詞開始,例如 InitNameArray 或 CloseDialog。
對(duì)于經(jīng)常使用的或較長(zhǎng)的名稱,推薦使用標(biāo)準(zhǔn)縮寫以使名稱保持在適當(dāng)?shù)拈L(zhǎng)度內(nèi)。通常多于 32 個(gè)字符的變量名會(huì)變得難以閱讀。使用縮寫時(shí),應(yīng)確保在整個(gè)腳本中保持一致。例如,在一個(gè)腳本或腳本集中隨意切換 Cnt 和 Count 將造成混亂。
下表列出了 VBScript 中可能用到的對(duì)象命名約定(推薦):
| 對(duì)象類型 | 前綴 | 示例 |
|---|---|---|
| 3D 面板 | pnl | pnlGroup |
| 動(dòng)畫按鈕 | ani | aniMailBox |
| 復(fù)選框 | chk | chkReadOnly |
| 組合框、下拉列表框 | cbo | cboEnglish |
| 命令按鈕 | cmd | cmdExit |
| 公共對(duì)話框 | dlg | dlgFileOpen |
| 框架 | fra | fraLanguage |
| 水平滾動(dòng)條 | hsb | hsbVolume |
| 圖像 | img | imgIcon |
| 標(biāo)簽 | lbl | lblHelpMessage |
| 直線 | lin | linVertical |
| 列表框 | lst | lstPolicyCodes |
| 旋鈕 | spn | spnPages |
| 文本框 | txt | txtLastName |
| 垂直滾動(dòng)條 | vsb | vsbRate |
| 滑塊 | sld | sldScale |
所有過程的開始部分都應(yīng)有描述其功能的簡(jiǎn)要注釋。這些注釋并不描述細(xì)節(jié)信息(如何實(shí)現(xiàn)功能),這是因?yàn)榧?xì)節(jié)有時(shí)要頻繁更改。這樣就可以避免不必要的注釋維護(hù)工作以及錯(cuò)誤的注釋。細(xì)節(jié)信息由代碼本身及必要的內(nèi)部注釋來描述。
當(dāng)傳遞給過程的參數(shù)的用途不明顯,或過程對(duì)參數(shù)的取值范圍有要求時(shí),應(yīng)加以說明。如果過程改變了函數(shù)和變量的返回值(特別是通過參數(shù)引用來改變),也應(yīng)在過程的開始部分描述該返回值。
過程開始部分的注釋應(yīng)包含以下區(qū)段標(biāo)題。相關(guān)樣例,請(qǐng)參閱后面的“格式化代碼”部分。
| 區(qū)段標(biāo)題 | 注釋內(nèi)容 |
|---|---|
| 目的 | 過程的功能(不是實(shí)現(xiàn)功能的方法)。 |
| 假設(shè) | 其狀態(tài)影響此過程的外部變量、控件或其他元素的列表。 |
| 效果 | 過程對(duì)每個(gè)外部變量、控件或其他元素的影響效果的列表。 |
| 輸入 | 每個(gè)目的不明顯的參數(shù)的解釋。每個(gè)參數(shù)都應(yīng)占據(jù)單獨(dú)一行并有其內(nèi)部注釋。 |
| 返回 | 返回值的解釋。 |
請(qǐng)記住以下幾點(diǎn):
每個(gè)重要的變量聲明都應(yīng)有內(nèi)部注釋,描述變量的用途。
應(yīng)清楚地命名變量、控件和過程,僅在說明復(fù)雜細(xì)節(jié)時(shí)需要內(nèi)部注釋。
應(yīng)在腳本的開始部分包含描述該腳本的概述,列舉對(duì)象、過程、運(yùn)算法則、對(duì)話框和其他系統(tǒng)從屬物。有時(shí)一段描述運(yùn)算法則的假碼是很有用的。
應(yīng)盡可能多地保留屏幕空間,但仍允許用代碼格式反映邏輯結(jié)構(gòu)和嵌套。以下為幾點(diǎn)提示:
標(biāo)準(zhǔn)嵌套塊應(yīng)縮進(jìn) 4 個(gè)空格。
過程的概述注釋應(yīng)縮進(jìn) 1 個(gè)空格。
概述注釋后的高層語句應(yīng)縮進(jìn) 4 個(gè)空格,每一層嵌套塊再縮進(jìn) 4 個(gè)空格。例如:
'*********************************************************' Purpose: Locates the first occurrence of a specified user ' in the UserList array.' Inputs: strUserList(): the list of users to be searched.' strTargetUser: the name of the user to search for.' Returns: The index of the first occurrence of the strTargetUser ' in the strUserList array. ' If the target user is not found, return -1.'*********************************************************Function intFindUser (strUserList(), strTargetUser) Dim i ' Loop counter. Dim blnFound ' Target found flag intFindUser = -1 i = 0 ' Initialize loop counter Do While i <= Ubound(strUserList) and Not blnFound If strUserList(i) = strTargetUser Then blnFound = True ' Set flag to True intFindUser = i ' Set return value to loop count End If i = i + 1 ' Increment loop counter LoopEnd Function
到此,關(guān)于“如何理解VBScript編碼約定”的學(xué)習(xí)就結(jié)束了,希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí),快去試試吧!若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí),請(qǐng)繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編會(huì)繼續(xù)努力為大家?guī)砀鄬?shí)用的文章!
名稱欄目:如何理解VBScript編碼約定-創(chuàng)新互聯(lián)
瀏覽路徑:http://www.jbt999.com/article20/ccgdjo.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供移動(dòng)網(wǎng)站建設(shè)、商城網(wǎng)站、品牌網(wǎng)站制作、網(wǎng)站改版、域名注冊(cè)、靜態(tài)網(wǎng)站
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:[email protected]。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容