时间戳

首页 > 技术文章 > 代码规范之注释篇

代码规范之注释篇

Joe-and-Joan 2019-07-02 09:02 原文

1.1 html注释写法

 <!-- 这是HTML的注释标签写法 -->

小诀窍:

  • 开始于左尖括号+ !--
  • 一看到尖括号就联想到html标签的写法，自然就想到了它是html注释，这样比较好记；
  • 使用 < 和 > 是符合HTML标签语法规则的;

1.2 html中的条件注释

<!--[if IE 9]>
    .... some HTML here ....
<![endif]-->

这个条件注释一般只针对IE版本的浏览器执行的 HTML 标签。

2.1 css和js注释写法

/*多行css、js代码注释  即代码块注释 */

// 单行css或js注释

注意：

  • css和js可以使用相同的注释写法；
  • 单行注释使用双斜杠；
  • 多行注释以斜杠 + 星开始，以 星 + 斜杠结束

3.1 举例

<!--注释内容-->
//注释内容 (在css或javascript中插入单行注释)
/*注释内容*/ (在css或javascript中插入多行注释)

JavaScript使用双斜杠注释单行代码：

// console.log("hello, JoeJoan'");

使用斜杠星注释代码块(多行代码):

/*
    let person = new Object();
        person.name = 'joe';
        person.age = '23',
        person.job = 'webEngineer';
   console.log("我是" + person.name + "," + person.age + "岁," + "我是一名" + person.job + "!" );
*/

 

4.1 注释之性能问题

  • 过多的JavaScript注释会降低JavaScript的执行速度与加载速度，因此在发布网站时，一般去掉JavaScript注释，可以使用gulp或webpack实现;
  • 注释块/* ... */中不能再包含有/*或*/，JavaScript正则表达式中可能产生这种代码，这样会产生语法错误;
  • 推荐使用//注释代码；

推荐阅读