HTML項(xiàng)目代碼編寫規(guī)范_html/css_WEB-ITnose
Jun 24, 2016 am 11:45 AM
如果本文檔中有任何錯(cuò)誤的、不符合行規(guī)的，敬請(qǐng)斧正。
引言
不管有多少人共同參與同一項(xiàng)目，一定要確保每一行代碼都像是同一個(gè)人編寫的。
若您對(duì)本文檔中任何內(nèi)容有不明白的，或者感覺不合行規(guī)的，請(qǐng)您按以下格式向我郵件說明，同時(shí)也歡迎任何人參與討論，共同完善本文檔。本文檔中很多也是根據(jù)我自己現(xiàn)在的公司需求來定的。
郵件不是QQ，請(qǐng)盡可能清晰的組織你的語言，將問題描述得更清楚，同時(shí)，不要使用過多的樣式化，合乎文檔排版標(biāo)準(zhǔn)，謝謝。
項(xiàng)目文件結(jié)構(gòu)
前端項(xiàng)目文件結(jié)構(gòu)
前端項(xiàng)目統(tǒng)一按以下目錄結(jié)構(gòu)管理項(xiàng)目文件：
/path/to/PROJECT_NAME/ scss/ base.scss main.scss _module_name.scss scripts/ build.js gulp.js build/ vendor/ THIRD_PARTY_LIBRARY_NAME/ VERSION/ MINIFIED_FILE_NAME/ assets/ css/ base.min.css base.min.map main.min.css main.min.map img/ logo.png logo@2x.png logo@3x.png js/ main.min.js main.min.map index.html layout.html PAGE_NAME.html template/ vendor/ THIRD_PARTY_LIBRARY_NAME/ VERSION/ MINIFIED_FILE_NAME/ assets/ css/ base.css main.css img/ logo.png js/ main.js index.html layout.html PAGE_NAME.html
在上面的目錄結(jié)構(gòu)中，大寫的名稱為可變的，即根據(jù)具體需求隨時(shí)更換，它們的語義分別為：
-
PROJECT_NAME
當(dāng)前項(xiàng)目的英文名稱（若叮當(dāng)錢包官方無法給出標(biāo)準(zhǔn)翻譯，或者拼音即是其名稱，則使用拼音全稱，或者使用其官方定義的短名稱），由純小寫字母 a-z 或者數(shù)字 0-9 以及中劃線 - 組成的字符串
-
template
模板目錄，用于開發(fā)使用
-
build
構(gòu)建目錄
-
vendor
所有第三方的文件均存放在 vendor 目錄中，在 vendor 中，任何第三方庫、樣式、腳本等均需要遵守以下規(guī)則存放：任何一個(gè)第三方庫均需要存放在其名稱下，在開發(fā)過程中，使用 bower 安裝。
HTML標(biāo)準(zhǔn)說明
文檔類型
任何一個(gè)HTML頁面，均必須使用下面這個(gè)文檔類型聲明：
<!DOCTYPE html>
在叮當(dāng)錢包的任何項(xiàng)目的 HTML 界面中，不允許出現(xiàn)該聲明之外的任何聲明。
合法性驗(yàn)證
合法的使用HTML，并利用w3c的工具（W3C HTML validator）進(jìn)行檢查。
語義性
根據(jù)目的合理使用HTML標(biāo)簽，例如 header、footer、nav、section 等標(biāo)簽，跟 div 十分類似，但是在語義上卻有天壤之別，比如下面這樣：
<article class="entry"> <header> <h1>讀《雙城記》</h1> </header> <section class="content"> <p><strong>《雙城記》</strong>（英語：<em>A Tale of Two Cities</em>）是英國(guó)作家查爾斯·狄更斯所著的一部以法?大革命為背景所寫成的長(zhǎng)篇?dú)v史小說，情?感人肺腑，是世界文??典名著之一，故事中?巴黎、?敦??大城市??起?，圍繞著曼奈特醫(yī)生一家和以德法奇夫婦為首的圣安東尼區(qū)展開故事。小說里描寫了貴族如何敗壞、如何殘害百姓，人民心中積壓對(duì)貴族的刻骨仇恨，導(dǎo)致了不可避免的法國(guó)大革命。本書的主要思想是為了愛而自我犧牲，?名中的「?城」指的是<strong>巴黎??敦</strong>。</p> <h2>人物介?</h2> <ul> <li>曼奈特?生（Dr. Alexandre Manette），一位老政治犯。</li> <li>露西·曼奈特（Lucie Manette），曼奈特?生的女?。</li> <li>查?斯·丹尼（Charles Darney），厄弗?蒙地侯爵的?子，?上露西·曼奈特。</li> <li>雪尼?卡?（Sydney Carton），一位?世嫉俗的律?，?上露西·曼奈特。</li> <li>德法奇（Ernest Defarge），曼奈特?生?日的?人。</li> <li>德法奇夫人（Madame Defarge/Teresa Defarge），一位?定的女革命者。</li> <li>?翰·拔沙（John Barsad），一位??。他的真?名字是索??（Solomon Pross） ，是波希小姐（Miss Pross）的哥哥。</li> <li>波希小姐（Miss Pross），露西的保姆。</li> <li>??·?利（Roger Cly），另一位??，?翰·拔沙的夥伴</li> </ul> </section></article><!-- /.entry -->
協(xié)議頭
建議在指向圖片、樣式表、JavaScript腳本或者其它媒體文件的URL地址中省略 http: 與 https: 協(xié)議部分，除非已知相應(yīng)文件不能同時(shí)兼容這兩個(gè)協(xié)議，比如：
我們不推薦下面這種方式：
<script src="http://www.doraemoney.com/vendor/jquery/2.1.3/jquery.min.js"></script><link rel="stylesheet" href="http://assets/css/style.css"/><style> .example { background: #fff url(http://www.doraemoney.com/assets/img/example-background.png) no-repeat center; }</style> 你應(yīng)該像下面這樣寫：
<script src="//www.doraemoney.com/vendor/jquery/2.1.3/jquery.min.js"></script><link rel="stylesheet" href="//assets/css/style.css"/><style> .example { background: #fff url(//www.doraemoney.com/assets/img/example-background.png) no-repeat center; }</style> 另外的示例，比如通過 
標(biāo)簽引入圖片，我們同樣不推薦這樣寫：
<img class="logo lazy" src="/static/imghw/default1.png" data-src="http://www.doraemoney.com/assets/img/logo.png" alt="叮當(dāng)錢包"/>
而應(yīng)該這樣寫：
<img class="logo lazy" src="/static/imghw/default1.png" data-src="//www.doraemoney.com/assets/img/logo.png" alt="叮當(dāng)錢包"/>
代碼縮進(jìn)
不允許在任何 HTML、CSS 以及 JavaScript 代碼中使用 Tab 進(jìn)行縮進(jìn)，且所有的縮進(jìn)只允許使用兩個(gè)空格 __ ，如下面這樣是正確的：
<a class="brand"> <img src="/static/imghw/default1.png" data-src="//www.doraemoney.com/assets/img/logo.png" class="lazy" alt="叮當(dāng)錢包" /></a>
而下面這樣均為錯(cuò)誤的：
<a class="brand"> <img src="/static/imghw/default1.png" data-src="//www.doraemoney.com/assets/img/logo.png" class="lazy" alt="叮當(dāng)錢包" /></a>
大小寫
所有的代碼都應(yīng)該是小寫的，包括元素名稱、屬性、屬性值（除非 text 或者 CDATA 的內(nèi)容）、選擇器、CSS屬性以及屬性值，如下面這樣均是錯(cuò)誤的：
<A HREF="http://www.doraemoney.com" TITLE="叮當(dāng)錢包官方網(wǎng)站首頁" CLASS="Brand"/>叮當(dāng)錢包</A>
正確的寫法應(yīng)該是：
<a href="http://www.doraemoney.com" title="叮當(dāng)錢包官方網(wǎng)站首頁" class="brand">叮當(dāng)錢包</a>
對(duì)于資源文件的命名，我們同樣要求全部使用純小寫字母，同時(shí)，多個(gè)單詞間使用中橫線分割（-），同時(shí)，不允許在命名中出現(xiàn)空格，英文字母必須放在第一個(gè)位置， - 不允許出現(xiàn)在名稱格式后綴小數(shù)點(diǎn) . 的前面，如下面這樣就是正確的命名方法：
logo.pngexample-background.pngassets/css/base.css
而下面這些均是錯(cuò)誤的：
logo-.png-logo.png0logo.pngexample background.pngExample-Background.pngExampleBackground.pngAssets/Css/Base.css
尾隨空格
尾隨空格是絕對(duì)不允許的，容易讓 diff 更加復(fù)雜，比如下面這樣是不允許的：
<h2>什么是叮當(dāng)錢包？ </h2><p>叮當(dāng)錢包的命名靈感來源于哆啦A夢(mèng)的四次元口袋，叮當(dāng)希望自己也可以像這個(gè)神奇口袋一樣，在小伙伴需要幫助時(shí)，伸出溫暖援（圓）手，給予大家“無所不能”的幫助。</p>
下面這樣才是正確的：
<h2>什么是叮當(dāng)錢包？</h2><p>叮當(dāng)錢包的命名靈感來源于哆啦A夢(mèng)的四次元口袋，叮當(dāng)希望自己也可以像這個(gè)神奇口袋一樣，在小伙伴需要幫助時(shí)，伸出溫暖援（圓）手，給予大家“無所不能”的幫助。</p>
注意仔細(xì)觀察，在 h2 標(biāo)簽中 ？ 號(hào)后面有無空格。
編碼格式
所有的文件，包括 .html、.css、.js、scss、less 等，必須全部使用 utf-8 編碼格式，如下面這樣的是正確的：
<head> <meta charset="utf-8" /></head>
代碼注釋
任何編寫代碼的人都必須根據(jù)需要撰寫代碼注釋，對(duì)于團(tuán)隊(duì)開發(fā)來說，這是非常重要的，比如下方是HTML的注釋規(guī)范：
<!-- 這是單行注釋 --><div class="foo"></bar><!-- 這是多行注釋的標(biāo)題 這是多行注釋中的一行-->
熱AI工具
Undress AI Tool
免費(fèi)脫衣圖片
Undresser.AI Undress
人工智慧驅(qū)動(dòng)的應(yīng)用程序，用於創(chuàng)建逼真的裸體照片
AI Clothes Remover
用於從照片中去除衣服的線上人工智慧工具。
Clothoff.io
AI脫衣器
Video Face Swap
使用我們完全免費(fèi)的人工智慧換臉工具，輕鬆在任何影片中換臉！
熱門文章
熱工具
記事本++7.3.1
好用且免費(fèi)的程式碼編輯器
SublimeText3漢化版
中文版，非常好用
禪工作室 13.0.1
強(qiáng)大的PHP整合開發(fā)環(huán)境
Dreamweaver CS6
視覺化網(wǎng)頁開發(fā)工具
SublimeText3 Mac版
神級(jí)程式碼編輯軟體(SublimeText3)
熱門話題
解釋ARIA中角色屬性的目的。
Jun 14, 2025 am 12:35 AM
ARIA的role屬性用於定義網(wǎng)頁元素的角色，提升無障礙性。 1.role屬性幫助輔助技術(shù)理解元素的功能，如按鈕、導(dǎo)航等。 2.使用role屬性可以為非語義HTML元素賦予特定角色。 3.role屬性應(yīng)與元素行為一致，並通過無障礙工具測(cè)試驗(yàn)證。
HTML和設(shè)計(jì)：創(chuàng)建網(wǎng)站的視覺佈局
Jun 14, 2025 am 12:39 AM
如何創(chuàng)建網(wǎng)站佈局？ 1.使用HTML標(biāo)籤定義內(nèi)容結(jié)構(gòu)，如、、。 2.通過CSS控製樣式和位置，使用盒模型、浮動(dòng)或Flexbox佈局。 3.優(yōu)化性能，減少HTTP請(qǐng)求，使用緩存和優(yōu)化圖像，確保響應(yīng)式設(shè)計(jì)。
如何確保您的HTML代碼可讀和可維護(hù)？
Jun 10, 2025 am 12:06 AM
提升HTML代碼的可讀性和可維護(hù)性可以通過以下步驟實(shí)現(xiàn)：1.使用語義化標(biāo)籤，如、、等，使代碼結(jié)構(gòu)清晰，提升SEO效果；2.保持代碼格式化，使用一致的縮進(jìn)和空格；3.添加適當(dāng)?shù)脑]釋，解釋代碼意圖；4.避免過度嵌套，簡(jiǎn)化結(jié)構(gòu)；5.使用外部樣式表和腳本，保持HTML簡(jiǎn)潔。
我如何了解最新的HTML標(biāo)準(zhǔn)和最佳實(shí)踐？
Jun 20, 2025 am 08:33 AM
要跟上HTML標(biāo)準(zhǔn)和最佳實(shí)踐，關(guān)鍵在於有意為之而非盲目追隨。首先，關(guān)注官方來源如WHATWG和W3C的摘要或更新日誌，了解新標(biāo)籤（如）和屬性，將其作為參考解決疑難問題；其次，訂閱可信的網(wǎng)頁開發(fā)新聞通訊和博客，每週花10-15分鐘瀏覽更新，關(guān)注實(shí)際用例而非僅收藏文章；再次，使用開發(fā)者工具和linters如HTMLHint，通過即時(shí)反饋優(yōu)化代碼結(jié)構(gòu)；最後，與開發(fā)者社區(qū)互動(dòng)，分享經(jīng)驗(yàn)並學(xué)習(xí)他人實(shí)戰(zhàn)技巧，從而持續(xù)提升HTML技能。
如何使用元素來表示文檔的主要內(nèi)容？
Jun 19, 2025 pm 11:09 PM
使用標(biāo)籤的原因是提升網(wǎng)頁的語義化結(jié)構(gòu)和可訪問性，使屏幕閱讀器和搜索引擎更易理解頁面內(nèi)容，並允許用戶快速跳轉(zhuǎn)至核心內(nèi)容。以下是關(guān)鍵要點(diǎn)：1.每個(gè)頁面應(yīng)僅包含一個(gè)元素；2.不應(yīng)包括跨頁面重複的內(nèi)容（如側(cè)邊欄或頁腳）；3.可與ARIA屬性結(jié)合使用以增強(qiáng)無障礙體驗(yàn)。通常位於和之後、之前，用於包裹唯一的頁面內(nèi)容，例如文章、表單或產(chǎn)品詳情，並應(yīng)避免嵌套在、或中；為提高輔助功能，可使用aria-labelledby或aria-label明確標(biāo)識(shí)部分。
如何創(chuàng)建基本的HTML文檔？
Jun 19, 2025 pm 11:01 PM
要?jiǎng)?chuàng)建一個(gè)基本的HTML文檔，首先需要了解其基本結(jié)構(gòu)並按照標(biāo)準(zhǔn)格式編寫代碼。 1.開始時(shí)使用聲明文檔類型；2.使用標(biāo)籤包裹整個(gè)內(nèi)容；3.在其中包含和兩個(gè)主要部分，用於存放元數(shù)據(jù)如標(biāo)題、樣式錶鍊接等，而則包含用戶可見的內(nèi)容如標(biāo)題、段落、圖片和鏈接；4.保存文件為.html格式並在瀏覽器中打開查看效果；5.隨後可逐步添加更多元素以豐富頁面內(nèi)容。遵循這些步驟即可快速構(gòu)建一個(gè)基礎(chǔ)網(wǎng)頁。
如何使用
Jun 19, 2025 pm 11:41 PM
要?jiǎng)?chuàng)建HTML複選框，需使用type屬性設(shè)為checkbox的元素。 1.基本結(jié)構(gòu)包含id、name和label標(biāo)籤，確保點(diǎn)擊文字可切換選項(xiàng)；2.多個(gè)相關(guān)複選框應(yīng)使用相同name但不同value，並用fieldset包裹提升可訪問性；3.自定義樣式時(shí)隱藏原生控件並用CSS設(shè)計(jì)替代元素，同時(shí)保持功能完整；4.確?？捎眯?，配對(duì)label、支持鍵盤導(dǎo)航且避免僅依賴視覺提示。以上步驟能幫助開發(fā)者正確實(shí)現(xiàn)兼具功能與美觀的複選框組件。
什麼是HTML標(biāo)籤？
Jun 13, 2025 am 12:36 AM
htmltagsareessentialforsstructuringwebpages.theydefinecontentandandlayoutingusingangusinginganglebrackets，通常是likeand，withsomebeingself-closingsellike.htmltagsarecracialforcialforcialforcialforcreatingstructructstructstructruct，可訪問，可訪問，可訪問，可訪問，henseo-seo-seo-seo-weeprylyweblages。
