网页制作过程中代码注释书写规范

所属分类: 网页制作 / 应用技巧 阅读数: 1997
收藏 0 赞 0 分享

总结了一下自己工作中使用到的注释书写规范,没有什么技术含量,只是用于统一制作方式,方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。
大部分同学使用的区域注释的方法,会以“注释内容开始”或“注释内容结束”、“start”或“end”等,相比之下,以“S”或“E”开始可以更快的使用,比如只要写一次开始或结束的注释,然后复制,改下“S”或“E”就可以快速的完成区域的注释。
区域注释
在实际工作中,有时会出现分不清注释应该在标签之上还是标签之下,为了避免这种情况,注释信息统一写在区域标签开始之前和结束之后,并以“S”或“E”开始,表示区域注释的开始或结束。
例:
<!--=S 注释内容-->
<div>
...
</div>
<!--=E 注释内容-->
/*=S 注释内容*/
.class{
...
}
.class{
...
}
/*=E 注释内容*/
单行注释
注释信息应写在需注释的内容区域里
例:
<div>
<!--注释内容-->
...
</div>
.class{
/*注释内容*/
...
}
#p#
注释层级
在模块制作中,可能会出现区域中还有区域的情况,为了更好的区分区域之间的层级,引入了注释层级的概念。
区域注释前面的等号表示了当前注释的层级
例:
<!--=S 注释内容-->
...
<!--==S 注释内容-->
...
<!--===S 注释内容-->
...
<!--===E 注释内容-->
...
<!--==E 注释内容-->
...
<!--=E 注释内容-->
/*=S 注释内容*/
...
/*==S 注释内容*/
...
/*===S 注释内容*/
...
/*===E 注释内容*/
...
/*==E 注释内容*/
...
/*=E 注释内容*/
协助注释
非作者维护时所加入的表示修改时间、修改人等标识信息。
在区域注释或单行注释的基础上加上修改人和修改时间等信息。
例(区域注释):
<!--==S 注释内容[修改人和修改时间]-->
<div>
...
</div>
<!--==E 注释内容[修改人和修改时间]-->
/*=S 注释内容[修改人和修改时间]*/
.class{
...
}
.class{
...
}
/*=E 注释内容[修改人和修改时间]*/
例(单行注释):
<div>
<!-- 注释内容[修改人和修改时间]-->
...
</div>
.class{
/*注释内容[修改人和修改时间]*/
...
}
更多精彩内容其他人还在看

CSS中浏览器对尺寸和宽高解释差异的解决方法

不同的浏览器对margin、padding、height、width 等属性的解释有很大的偏差。有时我们发现同样的两列布局,在不同的浏览器中两列长短不一,类似的情况太多了,如此困扰大家的麻烦,如何解决?
收藏 0 赞 0 分享

网页变灰的笔记 细节问题处理

grayscale.js这个文件是用来兼容各个浏览器的,在一般情况下,使用它绝对不会有问题,但是在实际的操作中,还是遇到了一些麻烦。
收藏 0 赞 0 分享

页面中marquee与flash同时存在时的冲突解决方案

冲突的症状主要表现在FLASH按钮一直跳动,不稳定,影响网页美观及正常访问。
收藏 0 赞 0 分享

提高网站访问速度的六种方法

以下6种优化方法都是前端的,前端优化的意义在于减少http请求,减少网站前端程序组成的体积。
收藏 0 赞 0 分享

新鲜出炉的有用图标集25组 国外下载

恰当的图标(ICON)能使网站更具活力 曾几何时,现在的网站图标大同小异,我们的眼睛早已见惯不惊。于是,这里收集了25套专业设计的全新的图标集,希望对你有用!
收藏 0 赞 0 分享

新手建站教程 十天学会做网站

十天学会做网站教程采用最通俗易懂的语言、从最基本的开始,带领大家开始建站。教程由许耀鹏历时半年时间写成。是非常好的新手建站入门教程。
收藏 0 赞 0 分享

新手建站入门教程 建站需要的条件和工具

很多新手在论坛都会说,我从来没做过网站,做网站需要些什么条件啊,会不会很难啊?
收藏 0 赞 0 分享

新手建站入门教程 域名的解析与绑定

昨天我们讲到了建立一个属于自己的网站需要的条件和工具,里面讲到首先需要注册一个属于自己的域名,和需要购买一个虚拟主机。(详情请看:新手建站第一帖:建站需要的条件和工具)
收藏 0 赞 0 分享

新手建站入门教程③ 别名(CNAME)记录和URL转发

在上一帖中为大家介绍了域名的解析和A记录解析的方法,今天我就为大家讲解一下另一种解析方法:别名(CNAME)记录。同时为大家讲解下URL转发的好处和方法。
收藏 0 赞 0 分享

新手建站入门教程④:如何绑定子目录

去买空间的时候,我想很多朋友都已经注意到了,有的空间介绍上会有类似于“支持绑定1个子目录”、“赠送1个子目录”等词。那么这些介绍是什么意思呢?
收藏 0 赞 0 分享
查看更多