总结了一下自己工作中使用到的注释书写规范,没有什么技术含量,只是用于统一制作方式,方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。
大部分同学使用的区域注释的方法,会以“注释内容开始”或“注释内容结束”、“start”或“end”等,相比之下,以“S”或“E”开始可以更快的使用,比如只要写一次开始或结束的注释,然后复制,改下“S”或“E”就可以快速的完成区域的注释。
区域注释
在实际工作中,有时会出现分不清注释应该在标签之上还是标签之下,为了避免这种情况,注释信息统一写在区域标签开始之前和结束之后,并以“S”或“E”开始,表示区域注释的开始或结束。
例:
<!--=S 注释内容-->
<div>
...
</div>
<!--=E 注释内容-->
/*=S 注释内容*/
.class{
...
}
.class{
...
}
/*=E 注释内容*/
单行注释
注释信息应写在需注释的内容区域里
例:
<div>
<!--注释内容-->
...
</div>
.class{
/*注释内容*/
...
}
上一页12 下一页 阅读全文
标签:
书写,规范,注释,代码,过程,网页制作,内容,<,...,修改

免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件! 如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
狼山资源网 Copyright www.pvsay.com

评论“网页制作过程中代码注释书写规范”

暂无“网页制作过程中代码注释书写规范”评论...

福利放送 2024/3/29

跑跑卡丁车单机版 2020-11-1(可与AI一起玩) 天翼云/百度云