html、css和js的注释规范用法有哪些


本文摘自PHP中文网,作者php中世界最好的语言,侵删。

这次给大家带来html、css和js的注释规范用法有哪些,使用html、css和js的注释有哪些的注意事项有哪些,下面就是实战案例,一起来看一下。

添加必要的注释,对一个有责任心、有道德模范的前端必须具备的好习惯,可以大大提高代码的可维护性、可读性。首先大家需要熟悉一下html、css、js的注释的写法:

html注释:

1

<!--注释内容-->

css注释:

1

2

//注释内容 单行注释(不推荐使用,因为有的浏览器可能不兼容,没有效果)

/*注释内容*/ 多行注释(推荐使用)

JavaScript:

1

//注释内容 单行注释/*注释内容*/ 多行注释

总结:

1

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

接下来是对注释在这几种代码中使用的位置,如何写注释进行总结一下。(根据个人的习惯可能不一样)

1、html注释

使用的位置:

1)一般会使用在一些主要节点标签结束的后边,如:

1

2

3

4

5

<div class="wrap">

<div class="main">

...

</div><!--main end-->

<div><!--wrap end-->


2)使用在一些循环的结束的后边,如:

1

2

3

4

5

<ul class="list">

    <li>111111</li>

    <li>222222</li>

    <li>333333</li>

</ul><!--list loop-->


这一切都是为了程序在嵌套的时候更加方便、明了。方便了他人同时也就方便了自己。程序嵌套的很乱,到时要你去修改那也是一份挺复杂的工序。

2、css注释

一般会使用在定义某个模块样式的上边,说明这段样式是作用于哪段模块,如:

1

2

3

4

5

6

7

8

/*通用 - 评论*/

.comment{...}

/*相册*/

.photo{...}

/*分享*/

.share{...}

/*投票*/

.vote{...}


3、javascript注释

一般将注释添加在某段功能函数的上边,说明函数的功能、作者、作者信息、修改时间。

1

2

3

4

5

6

//========================================================

//      截断字符

//      steepvi

//      rtx:*******

//      2010-10-14

//========================================================


最后,注释也是字符也是会有流量产生。因此当页面发布到正式地址的时候,最好加上一步优化流程。

压缩过程为非逆过程,保证本地是最新的而且带有注释的文件,压缩后上传服务器。服务器端的文件不可用作本地调试用。

相信看了这些案例你已经掌握了方法,更多精彩请关注php中文网其它相关文章!

相关阅读:

HTML图片的img标签怎样使用

HTML5的WEB界面中meta实列详解

HTML中如何使用html表单提交的操作

以上就是html、css和js的注释规范用法有哪些的详细内容,更多文章请关注木庄网络博客

相关阅读 >>

怎样让前端界面自动清理js、css文件的缓存

了解http事务、node模块化规范

html失效按钮怎么实现

html标记分为哪两种

javascript中,nan是什么类型?

html如何禁止右键

在html中各类型盒子的基线应如何确定

怎样在html里放视频

javascript怎么获取dom元素

html canvas截取圆角图片的实现方法

更多相关阅读请进入《javascript》频道 >>




打赏

取消

感谢您的支持,我会继续努力的!

扫码支持
扫码打赏,您说多少就多少

打开支付宝扫一扫,即可进行扫码打赏哦

分享从这里开始,精彩与您同在

评论

管理员已关闭评论功能...