不是每行代号都需要注释,但注释代码量要占10% ~ 20%,以免其他人在检测调试代码的时候,不知道这段代码是什么意思,还得从前面开始理解代码,增加别人的工作量。下面,我们来看看如何注释html、css、js代码吧。
html注释的格式html注释的格式是【 <!--代码块-->】,把注释的内容写在“<!--”和“-->”里面就可以了。这个表示多行或单行注释。
<!--这里写这个元素的层级、包含的大致内容、这个区域的名称-->
html注释的快捷键在sublime编辑代码的时候,可以使用快捷键组合【 ctrl+shift+/ 】来注释代码。
css注释的格式CSS注释的格式是【/* 注释内容 */】
js注释的格式js注射的格式是【// js代码】
先来说说html的注释代码吧html注释是这样的格式:你的代码块
,可以单行注释,也可以注释多行;在sublime中的快捷键是
ctrl+shift+/
,如图所示;
html的注释很多方面是给某一段落做说明,不仅让自己以后维护方便,也给其他接手的同事“赏心悦目”的感觉,一看就懂,更方便以后管理代码;如图所示,每个模块都做好注释,看起来都舒服的多吧~;
当然需要注意的是,虽然html的注释格式是
你的代码块
,但如果遇到
#include
你的代码块
等代码,切忌千万小心,这段可不一样,它是段包含语句,是调用了其他文件的一段代码,千万可别删掉了。如图所示;
再说说css注释代码;css注释是这样的格式:
/*
你的css
*/,多数情况下也是用于说明,如图所示;
当然也可以在css代码里面注释,表示这段代码暂时“屏蔽”不用;如图所示;
再说说js的注释;js单行注释是这样的格式:
//
你的js代码;
可以用于说明你当前代码的用途啊、作用啊等等~;如图所示;
js还能注释多行代码,格式跟css注释一样:/*
你的js
*;
如图所示,把整段暂时不用的代码注释掉~