文件命名規則

網站文件命名規則

關於文件的命名，看似無足重輕，但實際上若是沒有良好的命名規則進行必要的約束，一味的亂起名稱，最終致使的結果就是整個網站或是文件夾沒法管理。因此，命名規則在這裏一樣很是重要。 須要特別注意的時候，網站文件或文件夾命名請儘可能避免使用中文字符命名。

文件的命名

　　以最少的字母達到最容易理解的意義。
　　索引文件統一使用index.html文件名(小寫) index.html文件統一做爲"橋頁"，不製做具體內容，僅僅做爲跳轉頁和meta標籤頁。主內容頁爲main.html。
　　按菜單名的英語翻譯取單一單詞爲名稱。全部單英文單詞文件名都必須爲小寫，全部組合英文單詞文件名第二個起第一個字母大寫； 全部文件名字母間連線都爲下劃線。
　　例如： 關於咱們 \aboutus
　　　　　　信息反饋 \feedback
　　　　　　產　　品 \product

圖片的命名

　　以圖片英語字母爲名。以最少的字母達到最容易理解的意義。
　　對於較小的圖片，咱們使用以下格式的命名 ：
　　　　　　sm.kahn.gif
　　其中，sm 表明「small」，kahn 表明圖片的內容。較大圖像的命名規則也同樣，不過是以 bg 開頭的：
　　　　　　bg.kahn.gif
　　用以區分不一樣圖像的命名規則應當是全站通用的，這樣能夠儘可能避免將不一樣的名稱攪混。

網站目錄的命名

　　目錄創建的原則是以最少的層次提供最清晰簡便的訪問結構。
　　服務器的ftp上傳目錄默認爲html 根目錄文件 根目錄只容許存放index.html和main.html文件，以及其餘必須的系統文件。
　　每一個語言版本存放於獨立的目錄。已有版本語言設置爲： 簡體中文 \gb 繁體中文 \big5 英 語 \en 日 語 \jp 每一個主要功能(主菜單)創建一個相應的獨立目錄。 根目錄下的images爲存放公用圖片目錄，每一個目錄下私有圖片存放於各自獨立images目錄.
　　例如： \menu1\images
　　　　　　\menu2\images
　　另外，全部的js文件存放在根目錄下統一目錄\script 全部的CSS文件存放在根目錄下的style目錄 全部的CGI程序存放在根目錄並列目錄\cgi_bin目錄。
　　對於一些信息更新量比較大的站點或是欄目，還能夠採用一種更爲特殊的方式來進行文件架的命名，這樣能使得往後的維護更加方便，這樣的方式就是使用「單一單詞命名的目錄」+「年年年年_月月_日日」的方式命名，最後的「日日」是根據更新量大小可選擇的，若是每日更新量很大則能夠加上「日日」。
　　例如： \news\2005_08\
　　　　　　\news\2005_09\
　　　　　　\news\2005_10_12\

 

Dreamweaver文件的命名規則

　　在Dreamweaver中用戶能夠對一系列不一樣類型的對象進行命名，這些對象包括圖片、層、表單、文件、數據庫域等，這些對象將會被許多不一樣的工做引擎進行分析處理，這些工具包括各類瀏覽器、JavaScript腳本解析器、網絡服務器、應用程序服務器、查詢語言等等。
　　若是某個對象的名稱沒法被某個解析器識別，就有可能會致使故障的發生，更加麻煩的是用戶可能很難發現問題的緣由，例如某個具體的特效沒法正確顯示，或者是在某個特殊階段沒法正確顯示，有時故障可能只會在某種特殊狀況或在使用某個瀏覽器時發生，而在其它狀況下保持正常，用戶將很難分析出故障是因爲命名問題而致使的。
　　因爲須要命名的對象的種類不少，對這些對象進行解析的引擎工具也不少，所以用戶在給這些對象命名時應該遵循一個常規的標準，以確保廣泛兼容性。命名的基本原則就是：使用獨一無二的、小寫、不帶空格的名稱，名稱應由字母和數字組成，並以字母開始，名稱中能夠包含"_"符號。

獨一無二

　　請確保某對象的名稱與其它對象不一樣，保證其獨一無二的屬性。
　　例如： 你能夠將某對象命名爲"feedback_button_3"

小寫

　　有些服務器和腳本解析器對文件名的大小寫也進行檢查，而爲了不因大小寫引發的不兼容問題，建議用戶在命名時所有使用小寫文件名。

不帶空格

　　不一樣的解析器對空格等符號的解析結果不一樣，例如某些解析器會把空格視爲某個十六進制的數值，所以建議用戶使用不帶空格的單詞作爲文件對象的名稱。

詞數混合

　　用戶在命名中能夠隨意使用26個羅馬字母以及10個阿拉伯數字，而不建議使用其它標點符號。

以字母開始

　　有些解析器不喜歡以數字開頭的文件名。
　　例如： 在某些瀏覽器中的JavaScript腳本內部，若是使用"alpha23"這樣的名稱就不會出現問題，而若是使用"23alpha"這樣的名稱就可能會發生故障。

可包含"_"符號

　　爲了使某個對象的文件名獨一無二，用戶能夠經過使用"_"符號來更加詳細地描述文件名。
　　例如： 某對象的文件名能夠是"jd_background_17"。
　　除了上述原則標準以外，咱們還須要注意一些其它狀況，如文件名與系統的衝突。某些文件名可能知足上述標準，但可能還會致使故障的發生，緣由是由於它們與系統產生了衝突。
　　例如：當在使用JavaScript腳本函數時，不建議用戶將某個變量命名爲"for"，由於"for"在本系統下是一個工做語言字串，使用其命名某個變量可能會致使解析器工做出錯。許多程序都有一些保留名稱，這些名稱通常不建議用戶使用。 　
　　例如：用戶使用某個SQL程序保留的名稱來命名某個數據庫域，SQL對其進行分析時就可能會報錯。
　　此外，用戶在將不一樣來源的代碼編到一塊兒時，應該注意文件名的衝突狀況。
　　例如： 用戶把來自不一樣資源的兩個JavaScript行爲代碼編至同一網頁內，而這兩個行爲代碼的變量名相同，這時就有可能出現問題。
　　所以作爲查詢故障的一個技巧，在出現故障時，用戶能夠查詢一下相同網頁中是否存在相同文件名的變量名稱。

 

CSS類及id中的命名規則

　　Web開發人員能夠經過建立CSS類及id名稱並使用這些名稱來對divs以及其餘的格式頁面元素進行標識。對開發人員來講，在命名從新定義XHTML標記（tags）的CSS selectors時，必須保證其與預約義的標記準確匹配，但就類以及id選擇器名稱而言，則仁者見仁，智者見智。然而爲所欲爲的爲這些類以及id命名則並非個好的習慣。

直觀命名

　　當在設計Web頁面以及須要對一個div進行標識的時候，最天然的想法就是使用能夠描述元素所在頁面位置的詞彙來對其命名。
　　例如：top-panel
　　　　　horizontal-nav
　　　　　left-side
　　　　　center-column
　　　　　right-col

　　這些是CSS以及XHTML類和id的有效命名方式。這些詞彙簡單而且可以令人顧名思義，所以知足了標識頁面元素以及相應的CSS樣式的須要。

　　但問題是這樣的名稱同頁面內容的特定表達方式相關聯。這些命名參考了某種特定頁面佈局中的頁面元素位置，所以在這樣的佈局以外使用就會顯得不合適甚至形成理解混亂。這些命名沒有涉及文檔內容的結構。所以，下面給出了對CSS類以及ID命名更好的方法。

結構化命名

　　這些是CSS以及XHTML類和id的有效命名方式。這些詞彙簡單而且可以令人顧名思義，所以知足了標識頁面元素以及相應的CSS樣式的須要。 這些是CSS以及XHTML類和id的有效命名方式。這些詞彙簡單而且可以令人顧名思義，所以知足了標識頁面元素以及相應的CSS樣式的須要。

　　有標記的相關信息都是用來描述文檔的結構而不是外觀。這樣的特色使得咱們能夠經過簡單的改變CSS的方式來對不一樣外觀格式下的內容（content）以及標記（markup）進行重用。當你理解這種方式時，很容易就能夠發現採用頁面位置來爲類以及id命名的方式在處理如音頻（audio）等外觀格式上顯得很是不合適。所以，應當根據在文檔中的使用目的而非出現位置來對類以及id進行結構化命名。

　　能夠按照以下所示的結構化方式來對類以及id名稱命名：
　　例如：branding
　　　　　main-nav
　　　　　subnav
　　　　　main-content
　　　　　sidebar

　　這些名字同直觀命名方式同樣很是易懂，但他們描述了頁面元素的做用而非位置。這使得代碼更加符合使用純粹的結構化標記（structural markup）的初衷，即開發人員能夠在不改變標記的狀況下對各類各樣媒體下的顯示格式進行處理。

　　即便你不打算在其餘的媒體上對Web頁面進行格式修改，使用結構化命名方式還能夠幫助你在往後的站點升級或從新設計中更爲輕鬆。例如，結構化命名避免了當一個div同id right-column移動到頁面左邊後所帶來的混亂。對div sidebar的採用這樣的命名方式就顯得更加適當，由於不管它出如今頁面的哪一邊，這個名字仍然對開發人員來講直觀易懂。

慣例

　　Andy Clarke分析了40份由推崇標準化Web設計理念的開發人員所設計的Web站點的源代碼。儘管類以及id名稱很不統一，可是仍是發現了一些頻繁出現的經常使用名稱。這裏給出了最經常使用類/id名稱的示例列表：

　　例如：header
　　　　　content
　　　　　nav
　　　　　sidebar
　　　　　footer

 

VBScript中的命名規則

 

常數命名規則

　　VBScript 的早期版本不容許建立用戶自定義常數。若是要使用常數，則常數以變量的方式實現，且所有字母大寫以和其餘變量區分。常數名中的多個單詞用下劃線 (_) 分隔。
　　例如： USER_LIST_MAX 、NEW_LINE

　　這種標識常數的方法依舊可行，但您還能夠選擇其餘方案，用 Const 語句建立真正的常數。這個約定使用大小寫混合的格式，並以con」做爲常數名的前綴。
　　例如： conYourOwnConstant

變量命名規則

　　出於易讀和一致性的目的，請在 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

變量做用域命名規則

　　變量應定義在儘可能小的做用域中。VBScript 變量的做用域以下所示：

做用域	聲明變量處	可見性
過程級	事件、函數或子過程	在聲明變量的過程當中可見
Script 級	HTML頁面的HEAD部分，任何過程以外	在腳本的全部過程當中可見

變量做用域前綴命名規則

　　隨着腳本代碼長度的增長，有必要快速區分變量的做用域。在類型前綴前面添加一個單字符前綴能夠實現這一點，而不導致變量名過長。

做用域	前綴	示例
過程級	無	dblVelocity
Script 級	s	sblnCalcInProgress

描述性變量名和過程名的命名規則

　　變量名或過程名的主體應使用大小寫混合格式，而且儘可能完整地描述其目的。另外，過程名應以動詞開始，例如 InitNameArray 或 CloseDialog。

　　對於常用的或較長的名稱，推薦使用標準縮寫以使名稱保持在適當的長度內。一般多於 32 個字符的變量名會變得難以閱讀。使用縮寫時，應確保在整個腳本中保持一致。例如，在一個腳本或腳本集中隨意切換 Cnt 和 Count 將形成混亂。

對象命名規則

　　下表列出了 VBScript 中可能用到的對象命名約定（推薦）：

對象類型	前綴	示例
3D 面板	pnl	pnlGroup
動畫按鈕	ani	aniMailBox
複選框	chk	chkReadOnly
組合框、下拉列表框	cbo	cboEnglish
命令按鈕	cmd	cmdExit
公共對話框	dlg	dlgFileOpen
框架	fra	fraLanguage
水平滾動條	hsb	hsbVolume
圖像	img	imgIcon
標籤	lbl	lblHelpMessage
直線	lin	linVertical
列表框	lst	lstPolicyCodes
旋鈕	spn	spnPages
文本框	txt	txtLastName
垂直滾動條	vsb	vsbRate
滑塊	sld	sldScale

 

代碼註釋規則

　　全部過程的開始部分都應有描述其功能的簡要註釋。這些註釋並不描述細節信息（如何實現功能），這是由於細節有時要頻繁更改。這樣就能夠避免沒必要要的註釋維護工做以及錯誤的註釋。細節信息由代碼自己及必要的內部註釋來描述。

　　當傳遞給過程的參數的用途不明顯，或過程對參數的取值範圍有要求時，應加以說明。若是過程改變了函數和變量的返回值（特別是經過參數引用來改變），也應在過程的開始部分描述該返回值。

　　過程開始部分的註釋應包含如下區段標題。相關樣例，請參閱後面的「格式化代碼」部分。

區段標題	註釋內容
目的	過程的功能（不是實現功能的方法）。
假設	其狀態影響此過程的外部變量、控件或其餘元素的列表。
效果	過程對每一個外部變量、控件或其餘元素的影響效果的列表。
輸入	每一個目的不明顯的參數的解釋。每一個參數都應占據單獨一行並有其內部註釋。
返回	返回值的解釋。

　　請記住如下幾點：

• 每一個重要的變量聲明都應有內部註釋，描述變量的用途。
• 應清楚地命名變量、控件和過程，僅在說明覆雜細節時須要內部註釋。
• 應在腳本的開始部分包含描述該腳本的概述，列舉對象、過程、運算法則、對話框和其餘系統從屬物。有時一段描述運算法則的假碼是頗有用的。

格式化代碼

　　應儘量多地保留屏幕空間，但仍容許用代碼格式反映邏輯結構和嵌套。如下爲幾點提示：

• 標準嵌套塊應縮進 4 個空格。
• 過程的概述註釋應縮進 1 個空格。
• 概述註釋後的最高層語句應縮進 4 個空格，每一層嵌套塊再縮進 4 個空格。例如：

 '*********************************************************   ' 目的：    返回指定用戶在 UserList 數組中第一次出現的位置。   ' 輸入：    strUserList():   所查找的用戶列表。   '           strTargetUser:   要查找的用戶名。   ' 返回：    strTargetUser 在 strUserList 數組中第一次出現時的索引。   '           若是目標用戶未找到，返回 -1。   '*********************************************************     Function intFindUser (strUserList(), strTargetUser)       Dim i                     ' 循環計數器。       Dim blnFound        ' 發現目標的標記。       intFindUser = -1       i = 0                     ' 初始化循環計數器。       Do While i <= Ubound(strUserList) and Not blnFound           If strUserList(i) = strTargetUser Then                blnFound = True   ' 標記設爲 True。               intFindUser = i   ' 返回值設爲循環計數器。           End If           i = i + 1             ' 循環計數器加 1。       Loop   End Function