时间:2021-05-08
添加必要的注释,对一个有责任心、有道德模范的前端必须具备的好习惯,可以大大提高代码的可维护性、可读性。首先大家需要熟悉一下html、css、js的注释的写法:
html注释:
<!--注释内容-->
css注释:
//注释内容 单行注释(不推荐使用,因为有的浏览器可能不兼容,没有效果)
多行注释(推荐使用)
JavaScript:
//注释内容 单行注释
多行注释
总结:
//注释内容 (在css或javascript中插入单行注释)
(在css或javascript中插入多行注释)
接下来是对注释在这几种代码中使用的位置,如何写注释进行总结一下。(根据个人的习惯可能不一样)
1、html注释
使用的位置:
1)一般会使用在一些主要节点标签结束的后边,如:
<div class="wrap"><div class="main">...</div><!--main end--><div><!--wrap end-->2)使用在一些循环的结束的后边,如:
<ul class="list"> <li>111111</li> <li>222222</li> <li>333333</li></ul><!--list loop-->这一切都是为了程序在嵌套的时候更加方便、明了。方便了他人同时也就方便了自己。程序嵌套的很乱,到时要你去修改那也是一份挺复杂的工序。
2、css注释
一般会使用在定义某个模块样式的上边,说明这段样式是作用于哪段模块,如:
.comment{...}.photo{...}.share{...}.vote{...}3、javascript注释
一般将注释添加在某段功能函数的上边,说明函数的功能、作者、作者信息、修改时间。
//========================================================// 截断字符// steepvi// rtx:*******// 2010-10-14//========================================================最后,注释也是字符也是会有流量产生。因此当页面发布到正式地址的时候,最好加上一步优化流程。
压缩过程为非逆过程,保证本地是最新的而且带有注释的文件,压缩后上传服务器。服务器端的文件不可用作本地调试用。
以上所述是小编给大家介绍的html、css和js注释规范用法小结,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对网站的支持!
声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。
注释方便用户理解代码,而且易于网页的维护。html注释格式:,css,js等多行注释格式:,css,js等单行注释格式://注释内容。软件名称:
html中的普通注释:,这里面的XXXXXXXX是注释内容html中块注释css(除IE外都可识别2.3.4.5.6.7.8.9.10.11.Ite:lesst
strip_tags定义和用法strip_tags()函数剥去字符串中的HTML、XML以及PHP的标签。注释:该函数始终会剥离HTML注释。这点无法通过all
css注释用法CSS注释是以“”星号斜杠结束,注解说明内容放到“/*
GoogleHTML/CSS规范本文介绍了Google推荐的HTML和CSS编写格式规范,以建立良好的个人编码习惯。通用样式规范省略图片、样式、脚本以及其他媒体