Web前端開發規范
1.文件命名規則
1.1文件名稱的命名規則
統一用小寫的英文字母,數字和下划線的組合,不得包含漢字空格和特殊字符。
原則: 1)方便理解,見名之意
2)方面查找
1.2索引文件的命名規則(首頁面)
- index.htm
- index.html(常見的靜態網頁)
- index.asp(VB)
- index.aspx()
- index.jsp(Java)
- index.php(PHP)
1.3各個子頁面的命名規則
- 統一用翻譯的英文命名(推薦)
- 統一用拼音命名(拼音的簡化也可)
-
如果文件名過長,企業要提前約定一份縮寫的規范,如pro—product
- [x] 注意:不要中英文混用
例如:
- 首頁—index
- 產品列表—prolist產品詳細頁面—prodetail
- 新聞列表—newslist新聞詳細頁面—newsdetail
- 發展歷史—history
- 關於我們—aboutus
- 聯系我們—linkus,contactus
- 信息反饋—feedback留言—leavewords
1.4圖片命名規范
圖片的名稱分為頭尾兩部分,用下划線隔開,頭部表示此圖片的大類性質,例如廣告,標志,菜單,按鈕等
- banner:放置在頁面頂部的廣告,裝飾圖案等長方形的圖片
- logo:標志性的圖片
- button:在頁面上位置不固定,並且帶有鏈接的小圖片
- menu:在頁面中某一位置連續出現,性質相同的鏈接欄目的圖片
- pic:裝飾用的圖片
例子:
- banner_sohu.gif, banner_sina.gif
- menu_aboutus.gif,menu_job.gif
- title_news.gif
- logo_police.gif
- pic_people.gif
1.5腳本文件和動態文本文件命名規則
腳本文件:一般使用腳本功能的英文小寫縮寫命名
- 實際模塊:例如廣告條的javascript文件名為ad.js,彈出窗口的javascript文件名為pop.js
- 公用模塊:js文件命名:英文命名,后綴js。如common.js,basic.js
- 外部資源:Jquery.min.js,Jquery.validate.js,Jquery.date.js
動態文件:以性質描述,可以有多個單詞,用‘_’隔開,性質一般是該頁面的概要(見名知意)。
范例:register_form.aspx,register_post.aspx,topic_lock.aspx。不同模塊之間,可以使用不同的前綴來區分