首页 ┆ 网站地图 ┆ 在线留言 ┆ 游戏资讯 ┆ 资源下载 ┆ 端午节祝福 ┆ 迅雷在线影视
设为首页
加入收藏
联系我们
高级搜索
您当前的位置: 主页>网站制作>建站常识>网页代码的注释书写规范经验总结
网页代码的注释书写规范经验总结
来源: 发布时间:2008-10-06 发布人: 浏览: 人次   字体: [ ]  

  我总结了一下自己工作中使用到的注释书写规范,主要是注意规范,便于统一制作方式,也方便维护,毕竟良好的代码编写风格能够帮助我们在制作网页的时候思路清晰。

  这些经验包含“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。大部分朋友使用的区域注释的方法会以“注释内容开始”或“注释内容结束”、“start”或“end”等,相比之下,以“S”或“E”开始可以更快的使用,比如只要写一次开始或结束的注释,然后复制,改下“S”或“E”就可以快速的完成区域的注释。

  区域注释

  在实际工作中,有时会出现分不清注释应该在标签之上还是标签之下,为了避免这种情况,注释信息统一写在区域标签开始之前和结束之后,并以“S”或“E”开始,表示区域注释的开始或结束。

例:

<!--=S 注释内容-->
<div>
...
</div>
<!--=E 注释内容-->

/*=S 注释内容*/
.class{
...
}
.class{
...
}
/*=E 注释内容*/

  单行注释

  注释信息应写在需注释的内容区域里

例:

<div>
<!--注释内容-->
...
</div>

.class{
/*注释内容*/
...
}

  注释层级

  在模块制作中,可能会出现区域中还有区域的情况,为了更好的区分区域之间的层级,引入了注释层级的概念。区域注释前面的等号表示了当前注释的层级

例:

<!--=S 注释内容-->
...
  <!--==S 注释内容-->
  ...
    <!--===S 注释内容-->
    ...
    <!--===E 注释内容-->
  ...
  <!--==E 注释内容-->
...
<!--=E 注释内容-->

/*=S 注释内容*/
...
/*==S 注释内容*/
...
/*===S 注释内容*/
...
/*===E 注释内容*/
...
/*==E 注释内容*/
...
/*=E 注释内容*/

  协助注释

  非作者维护时所加入的表示修改时间、修改人等标识信息。在区域注释或单行注释的基础上加上修改人和修改时间等信息。

  例(区域注释):

<!--==S 注释内容[修改人和修改时间]-->
<div>
...
</div>
<!--==E 注释内容[修改人和修改时间]-->

/*=S 注释内容[修改人和修改时间]*/
.class{
...
}
.class{
...
}
/*=E 注释内容[修改人和修改时间]*/

例(单行注释):

<div>
<!-- 注释内容[修改人和修改时间]-->
...
</div>

.class{
/*注释内容[修改人和修改时间]*/
...
}


相 关 文 章   发布商链接
·实现当前页面的所有链接都在新窗口中...
·详解分析在IE和Firefox下有关CSS兼容...
·网站的防盗链系统是如何做的?
·让你的网站轻松加入Alexa五星级行列
·网站域名概念大扫盲
·为什么要进行网站备案 该怎么操作...
·教你如何根据网页HTML文档的结构选择...
·祥解CSS容易被人忽略的overflow : ...
·浅谈div布局的一些特性
·如何使中文网页内容表现的恰当好处
 §最新评论:(评论内容只代表网友观点,与本站立场无关!)
网名: 验证码:  【所有评论】【↑返回顶部
评 分: 12 345
评论内容:(不能超过500字,请自觉遵守互联网相关政策法规。[按 Ctrl+Enter 可直接提交]
注意:请勿在本站发布政治话题、色情及违反法律的内容。
IT知道网 声明:刊登此文章是为了传递更多信息,文章内容仅供参考,转载请注明出处。
推 荐 文 章
·如何优化CSS书写提高代码的效
·谈谈Div+CSS标准化设计的好处
·使用iframe造成的页面内容不...
·当DIV为空时在Ie中占物理空间
·常见的URl转义字符和特殊符号
·网站开发要用的HTML特殊符号...
·当前主要的中文站点使用编码...
·提高网页打开速度的几点基本...
·Div中使用ul多行多列布局,附
·overflow的另类使用,附图解
·CSS规则和CSS层叠样式的应用
·如何做到iframe框架自适应高...
·如何在网页中调用Flash才符合...
·防止网站iframe挂马的解决方...
·了解css中的id和CssClass的区
热 门 文 章
·HTML之frameset标记应用实例
·css div 不换行的解决方法
·防止网站iframe挂马的解决方...
·常见的URl转义字符和特殊符号...
·祥解CSS容易被人忽略的overfl...
·使用iframe造成的页面内容不...
·网站开发要用的HTML特殊符号...
·实现当前页面的所有链接都在...
·如何减少网页的内存使用和CPU...
·如何做到iframe框架自适应高...
·了解css中的id和CssClass的区...
·如何在网页中调用Flash才符合...
·网站的防盗链系统是如何做的...
·Div中使用ul多行多列布局,附...
·当编辑div的style属性中的bor...
网站首页 - 关于本站 - 加入收藏 - 网站地图 - 友情连接 - 在线留言 - 联系我们 - 返回顶部
Copyright © 2007 IT知道网.[冀ICP备07026896号]. All Rights Reserved .