Skip to content

注释规范

HTML 注释标准写法

html
<!-- Content Text -->

单行注释

html
<!-- Content Text -->
<div>...</div>

模块注释

  • 模块注释一般采用模块开始与模块结束
html
<!-- Header Start -->
<div class="header"></div>
<!-- Header End -->

<!-- Main Start -->
<div class="main"></div>
<!-- Main End -->

<!-- Footer Start -->
<div class="footer"></div>
<!-- Footer End -->

嵌套模块注释

html
<!-- Box Start -->
<div class="box">
  <!-- /box-a -->
  <div class="box-a"></div>

  <!-- /box-b -->
  <div class="box-b"></div>

  <!-- /box-c -->
  <div class="box-c"></div>
</div>
<!-- Box End -->