HTML 代码注释规范

2019-1-7 15:10| 作者: admin| 查看: 6017| 评论: 0|来自: 蚂蚁部落

注释对于团队开发和后期维护有着重要的作用,但是也增加了代码的体积。

尽量不写注释,尽可能减少文档的体积,如果必须要添加注释,那么就要遵循如下规则:

(1).详尽注释,解释代码解决问题、解决思路、是否为新鲜方案等。

(2).模块注释,github建议不使用模块结束注释。

[HTML] 纯文本查看 复制代码
<!-- 新闻列表模块 --> 
<div class="news">  
</div>
<!-- /新闻列表模块 --> 
<!-- 有不少规范建议不使用结束模块的注释,加重文件负荷 -->

特别说明:注释文本与两端(--)之间要有一个空格。

(3).待办注释:

[HTML] 纯文本查看 复制代码
<!-- TODO:待办事项 -->
...

说明还有没有完成的代码,给浏览器者一个提示。

(4).多行注释:

HTML多行注释与单行注释的语法是完全一样的,只要进行换行即可。

简单代码实例如下:

[HTML] 纯文本查看 复制代码运行代码
<!doctype html>
<html>
<head>
<meta charset="utf-8">
<meta name="author" content="http://www.softwhy.com/" />
<title>蚂蚁部落</title>
</head>
<body>
  <!--蚂蚁部落单行注释-->
  <!--
    蚂蚁部落注释一
    蚂蚁部落注释二
  -->
</body>
</html>

可以看到HTML的注释采用相同的语法形式,换行既是多行注释。


鲜花

握手

雷人

路过

鸡蛋

最新评论

返回顶部