HTML5 代码规范是一组指导原则和最佳实践,用于确保代码的一致性、可读性和可维护性。以下是一些通用的 HTML5 代码规范:

1. 缩进和空格:
   - 使用空格或制表符进行缩进,保持一致性。通常建议使用两个或四个空格进行缩进。

2. 文件编码:
   - 使用 UTF-8 编码,确保文件头部声明的编码正确。
   <!DOCTYPE html>
   <html lang="en">
   <head>
     <meta charset="UTF-8">
     <title>Document</title>
   </head>
   <body>
     <!-- 页面内容 -->
   </body>
   </html>

3. 标签的使用:
   - 使用小写字母书写标签名,保持一致性。
   - 对于自闭合标签,省略尾部斜杠 /。

4. 属性的使用:
   - 使用双引号而非单引号,保持一致性。
   - 属性名使用小写字母,保持一致性。
   - 不要省略可选的属性值,例如,对于布尔属性,写明完整的值。
   <input type="text" id="username" class="input" placeholder="Enter your username" disabled="disabled">

5. 注释:
   - 使用 <!-- 注释内容 --> 格式添加注释,提高代码可读性。
   <!-- 这是一个注释 -->
   <p>This is a paragraph.</p>

6. 结构语义:
   - 使用语义标签,如 <header>、<nav>、<main>、<section> 等,提高文档结构的可读性。
   <header>
     <h1>Website Title</h1>
   </header>
   <nav>
     <ul>
       <li><a href="#">Home</a></li>
       <li><a href="#">About</a></li>
       <!-- ... -->
     </ul>
   </nav>
   <main>
     <!-- 页面主要内容 -->
   </main>

7. 属性顺序:
   - 保持属性的一致顺序,例如,先写类名、再写 ID、然后是其他属性。
   <div class="box" id="myBox" data-info="123" style="color: red;">
     <!-- 内容 -->
   </div>

8. HTML5 Doctype:
   - 使用 HTML5 Doctype 声明文档类型。
   <!DOCTYPE html>
   <html>
   <!-- 页面内容 -->
   </html>

这些规范是一些建议,具体规范可能因项目或团队而异。在团队中建立并遵循一致的代码规范有助于提高代码质量和协作效率。通常,工具如 ESLint 或 Prettier 可以帮助团队自动检查和格式化代码,确保符合规范。


转载请注明出处:http://www.zyzy.cn/article/detail/3685/HTML5