注册本站  论坛  繁體中文

慧民电脑芯片级维修-电脑技巧
手机 | MP3 | MP4 | 显卡 | 主板 | 显示器 | 光存储 | 笔记本 | 网络设备 | 移动存储 | 数码相机
键鼠 | CPU | 音箱 | GPS | 电视 | 服务器 | 投影机 | 机箱电源 | 品牌电脑 | 办公打印 |
| 网站首页 | Cisco | Windows | Linux | Java | Dotnet | Oracle | 网页设计 | 平面设计 | 安全 | 软件应用 | 电脑维修 | 办公维修 |
您现在的位置: 电脑技巧 >> 网页设计 >> 心得技巧 >> 网页设计正文

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

文章来源:网页教学网 作者:佚名 更新时间:2008-10-8 16:02:16 【 】 【加入收藏

总结了一下自己工作中使用到的注释书写规范,没有什么技术含量,只是用于统一制作方式,方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。

大部分同学使用的区域注释的方法,会以“注释内容开始”或“注释内容结束”、“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{
/*注释内容[修改人和修改时间]*/
...
}

  • 上一篇网页设计:

  • 下一篇网页设计:
  • 最 新 热 门
     ireworks制作多样式实用网页按钮
     ireworks简单绘制甲壳虫小轿车
     ireworks仿真绘画质感金属球
     ireworks快速制作带血的金属刀具
     ireworks教程:果冻水晶字
     ireworks教程:gif动画图片批量增加水印
     ireworks教程:美女照片超绚背景
     ireworks教程:3D旋转gif动画
     ireworks教程:制作粉色恋人闪字
     ireworks CS3教程:切片工具切网页模板
    最 新 推 荐
     国网站用户体验排行榜
     计理论:以人为本的绿色设计
     结网页设计制作的一些通则
     页设计关于超级链接的设计原则
     页制作关于HTML格式和长文件的建议
     页布局的9个建议
     页页面设计的4个实用建议
     页内容页面制作的9个实用建议
     页设计经验谈:自以为是的网页设计者
     页制作过程中代码注释书写规范
    相 关 文 章

    ireworks制作多样式实用网页按钮
    ireworks快速制作带血的金属刀具
    ireworks教程:制作粉色恋人闪字
    ireworks教程:制作网页公告的装饰
    ireworks教程:制作滚动的足球动画
    ireworks教程:轻松制作水晶小图标
    ireworks教程:简单制作网页新闻播报框
    ireworks教程:制作精致英文网页导航
    ireworks教程:制作文字效果各种方法
    ireworks教程:制作水波gif动画

    | 设为首页 | 加入收藏 | 联系站长 | 友情链接 | 版权申明 | 网站公告

     

    Copyright 2006-2008 pcjx.com All Rights Reserved
    电脑技巧 版权所有 粤ICP备06059145号 地图
    门市地址:广东省佛山市南海区黄岐黄海路133号
    本网站所有内容未经许可不得转载或做其他使用