欢迎来到HELLO素材网! 南京网站制作选择顺炫科技
丰富的DIV CSS模版、JS,jQuery特效免费提供下载
当前位置:主页 > 建站教程 > DIVCSS教程 >

HTML 代码注释规范

发表于2019-04-12 13:10| 次阅读| 来源网络整理| 作者session

摘要:注释对于团队开发和前期维护有着重要的作用,然而也添加了代码的体积。尽量不写注释,尽能够缩小文档的体积。

注释对于团队开发和前期维护有着重要的作用,然而也添加了代码的体积。

尽量不写注释,尽能够缩小文档的体积,假设必需要减少注释,那么就要遵照如下规则:

(1).详尽注释,解释代码处理成绩、处理思绪、能否为新颖计划等。

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

[HTML] 纯文本查看 复制代码

<!-- 旧事列表模块 --> <div class="news"> </div> <!-- /旧事列表模块 --> <!-- 有不少规范建议不利用完结模块的注释,加重文件负荷 -->

顺便阐明:注释文本与两端(--)之间要有一个空格。

(3).待办注释:

[HTML] 纯文本查看 复制代码

<!-- TODO:待办事项 --> ...

阐明还有没有实现的代码,给阅读器者一个揭示。