天极传媒:
天极网
比特网
IT专家网
52PK游戏网
极客修
全国分站

北京上海广州深港南京福建沈阳成都杭州西安长春重庆大庆合肥惠州青岛郑州泰州厦门淄博天津无锡哈尔滨

产品
  • 网页
  • 产品
  • 图片
  • 报价
  • 下载
全高清投影机 净化器 4K电视曲面电视小家电滚筒洗衣机
您现在的位置: 天极网 > 软件 > 网页>评测>注意网页制作过程中注释书写规范

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

天极网软件频道2008-10-05 08:13我要吐槽

  良好的代码编写风格能够帮助我们在制作网页的时候思路清晰,其中代码的注释也有一些小的学问。

  我总结了一下自己工作中使用到的注释书写规范,其实也没有什么技术含量,主要是注意规范,便于统一制作方式,也方便维护。

  这些经验包含“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。大部分朋友使用的区域注释的方法会以“注释内容开始”或“注释内容结束”、“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{
/*注释内容[修改人和修改时间]*/
...
}

作者:论坛整理责任编辑:杨玲)
请关注天极网天极新媒体 最酷科技资讯
扫码赢大奖
评论
* 网友发言均非本站立场,本站不在评论栏推荐任何网店、经销商,谨防上当受骗!
热点推荐
微软Windows 10操作系统Win10系统在Win8的基础上对界面、特性以及跨平台方面做了诸多优化。[详细]
Windows 10 新视界 [进入频道][使用技巧][微博互动]
手机整机DIY企业级