HTML-101 #3. 注释与命名约定

Source: Dev.to

介绍

我正在学习 HTML，并将学习过程公开记录，作为 HTML‑101 系列的一部分。该系列面向初学者，分享我的理解、困惑以及学习所得。

在本篇文章中，我将讨论：

• 什么是 HTML 注释
• HTML 注释的语法
• 基本示例
• 重要规则与限制
• HTML 注释 与 CSS 注释 与 JavaScript 注释 的区别
• HTML 文件命名规范（标准首页名称、常见约定）

所有笔记、示例和练习代码均已上传至 GitHub 仓库：

https://github.com/dmz-v-x/html-101

HTML 注释

定义

注释是代码中的文本标注，用于解释目的、逻辑或历史。它们对开发者可见，渲染时会被浏览器忽略，不会出现在最终网页上。不过，注释的 HTML 仍会被发送到浏览器，因此不要在注释中放置机密信息。

语法

<!-- comment -->

位于 <!-- 与 --> 之间的所有内容都会被浏览器忽略。

基本示例

<!-- My Website -->
<h1>Hello World</h1>

重要规则与限制

• 不可嵌套 – 注释不能嵌套。下面的写法是无效的，会导致 HTML 破坏：

  <!--
  -->

• 不安全 – 注释可以在浏览器的开发者工具中看到。切勿在注释中存放敏感信息（例如密码）。

• 临时禁用 – 使用注释来解释代码，而不是永久性地禁用大块代码。

其他语言的注释语法

HTML 文件命名规范

标准首页名称

默认的首页文件应命名为 index.html（全小写，且不含空格）。

常见文件命名约定

• 仅使用小写字母。
• 用连字符 (-) 而非下划线 (_) 分隔单词。
• 文件名中避免出现空格。

示例

• about-us.html ✅
• contact-page.html ✅

文件类型示例

要点

• HTML 注释有助于文档化，但仍会被传输到浏览器；请确保注释中不包含敏感数据。
• 对文件使用统一的、全小写、连字符分隔的命名方案，并以 index.html 作为首页文件。

下一篇

下一篇文章将介绍 标题、段落与换行，并继续在 GitHub 仓库中更新新笔记。

仓库地址: https://github.com/dmz-v-x/html-101