# 基础入门-第2章-2.3-注释与代码规范 ## 一、学习目标 - 掌握HTML注释的语法规则及使用场景 - 理解代码格式化对可维护性的影响，掌握缩进与命名规范 - 掌握语义化书写原则，区分结构与样式的职责边界 ## 二、概念讲解 ### 2.1 注释的作用与意义 HTML注释是对代码的说明性文字，不会被浏览器解析显示，其核心价值在于： - **提高可读性**：帮助团队协作或后期维护时快速理解代码逻辑 - **调试辅助**：临时注释代码块进行功能测试，定位问题 - **文档化**：标记代码版本、作者、功能模块等元信息 ### 2.2 代码规范的重要性 规范的代码风格是工程化开发的基础，直接影响： - **可维护性**：统一的缩进、命名规则降低团队协作成本 - **可扩展性**：语义化结构便于后期功能迭代 - **兼容性**：避免因格式问题导致的解析异常（如标签嵌套错误） ## 三、语法参考 ### 3.1 HTML注释语法 ```html --> ``` ### 3.2 代码格式化规范 #### 3.2.1 缩进规则 - 使用**2个空格**作为缩进单位（避免使用Tab，确保跨编辑器一致性） - 标签嵌套时，子标签缩进一级 ```html ``` #### 3.2.2 命名规范 - **class/id命名**：使用小写字母，多个单词用连字符（-）连接（kebab-case） - **语义优先**：名称反映功能而非样式（如`user-list`而非`red-box`） - **避免缩写**：除非是公认缩写（如`nav`、`btn`） ```html ``` ## 四、实战示例 ### 4.1 规范注释与格式化代码示例 ```html

前端代码规范实践

发布日期：2025-07-25

本文介绍HTML代码规范的核心要点...

``` ### 4.2 语义化书写对比 | 非语义化写法（不推荐） | 语义化写法（推荐） | 优势 | |----------------------|-------------------|------| | `