页面注释规范
前端工作者常用到的注释有4个:
1、html注释:<!--被注释掉的内容-->
2、CSS注释:/*被注释掉的内容*/
3、脚本单行注释://被注释掉的内容
4、脚本多行注释:/*被注释掉的内容*/
注释不规范,在部分版本较低的浏览器中容易引起解析错误。
引起这种bug的错误注释有以下几种:
1、注释内容中间有符号“--”:<!--被注释掉的内--容-->
2、有些人为了方便好看会这样写:<!-- ------------被注释掉的内容--------------- -->,如果为了方便好看,可以这样写:<!-- ============被注释掉的内容========== -->
3、以此类推,CSS注释中切忌这样写:/* ************被注释掉的内容************ */或者这样写/*被**********注释掉的内容*/,都是不可取的。
4、同理JS注释一样。
注意:除了注释标记符“<!—”和“ -->”或者“//”或者“/*”和“*/”,内容之间或之外最好不要有与注释标记符中相同的符号。