成都网站建设,10年成都网站设计公司-验收合格再付款 网站建设分站|模板网站分站|网站维护分站
banner
网站首页 > 建站大学 > 技术支持 > HTML注释规范

HTML注释规范

添加时间:2019-04-22 22:56:18 编辑:成都网站建设 文章内容: 1919个字 阅读时间:约6分钟

HTML注释规范写法应该遵循以下标准:

Comments must start with the four character sequence U+003C LESS-THAN SIGN, U+0021 EXCLAMATION MARK, U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS (” (U+003E) character, nor start with a U+002D HYPHEN-MINUS character (-) followed by a “>” (U+003E) character, nor contain two consecutive U+002D HYPHEN-MINUS characters (–), nor end with a U+002D HYPHEN-MINUS character (-). Finally, the comment must be ended by the three character sequence U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN (–>).

  • 必须以4个有序字符开始:编码为 U+003C LESS-THAN SIGN 的小于号, 编码为 U+0021 EXCLAMATION MARK 的感叹号, 编码为 U+002D HYPHEN-MINUS 横线, 编码为 U+002D HYPHEN-MINUS横线 ,即 “
  • 在此之后是注释内容,注释的内容有以下限制:
    • 不能以单个 “>” (U+003E) 字符开始
    • 不能以由 “-“(U+002D HYPHEN-MINUS)和 ”>” (U+003E) 组合的字符开始,即 “->”
    • 不能包含两个连续的 U+002D HYPHEN-MINUS 字符,即 “–”
    • 不能以一个 U+002D HYPHEN-MINUS 字符结束,即 “-”
  • 必须以3个有序字符结束:U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN,即 “–>”

标准写法:

 

错误的写法:

The Wrong Comment Text-->  The Wrong Comment Text-->     

参考 www.w3.org #Comments

团队约定

单行注释

一般用于简单的描述,如某些状态描述、属性描述等

注释内容前后各一个空格字符,注释位于要注释代码的上面,单独占一行

推荐:

 <div>...div> 

不推荐:

<div>...div>   <div>  ... div> 

模块注释

一般用于描述模块的名称以及模块开始与结束的位置

注释内容前后各一个空格字符, 表示模块开始,表示模块结束,模块与模块之间相隔一行

推荐写法:

  <div class="mod_a">  ... div>      <div class="mod_b">  ... div>  

不推荐写法:

 <div class="mod_a">  ... div>    <div class="mod_b">  ... div>  

嵌套模块注释

当模块注释内再出现模块注释的时候,为了突出主要模块,嵌套模块不再使用

  

而改用

 

注释写在模块结尾标签底部,单独一行。

 <div class="mod_a">    <div class="mod_b">  ...  div>      <div class="mod_c">  ...  div>     div> 

上一篇:HTML文件模版下一篇:HTML代码规范
如没有特殊注明,本文均来自于啄木鸟建站原创,转载请注明来自https://www.40b.cn/jishu/255.html

相关新闻

推荐新闻

成都网站建设案例

网站首页 联系我们 电话咨询 短信咨询 QQ咨询

啄木鸟工作室,为建站而生!网站建设 And 建站套餐