网页制作过程中应代码注释书写要注意的问题
日期:2008年10月4日 作者: 查看:[大字体 中字体 小字体]-
良好的代码编写风格能够帮助我们在制作网页的时候思路清晰,其中代码的注释也有一些小的学问。我总结了一下自己工作中使用到的注释书写规范,其实也没有什么技术含量,主要是注意规范,便于统一制作方式,也方便维护。这些经验包含“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。大部分朋友使用的区域注释的方法会以“注释内容开始”或“注释内容结束”、“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{
/*注释内容[修改人和修改时间]*/
...
}(出处:http://www.hackhome.com)
-
- 网页制作过程中应代码注释书写要注意的问题 相关文章:
- ·15种做爱姿势真人示范写真(图)
- ·入党申请书范例九
- ·计算机实习报告范文
- ·大学毕业生自荐信(范文)
- ·大学生暑期农村教育实践报告范文
- ·大学生农村暑期社会实践报告范文
- ·浙江大学生暑期社会实践报告范文
- ·2006入党申请书范文
- ·毕业生实习鉴定范文
- ·农民生活状况调查的暑期社会实践报告范文
- 网页制作过程中应代码注释书写要注意的问题 相关软件
- ·五子棋规范教程
- ·软件开发规范及开发计划书
- ·vc++编程技巧与范例
- ·电眼美女范冰冰性感写真美图
- ·网页中的特效(示范样书)
- ·半条命 高动态范围渲染效果演示介绍
- ·极品美女范冰冰性感时尚写真美图
- ·2精讲课程审计_范永亮03
- ·百变精灵范冰冰写真壁纸
- ·防范黑客
- 特别声明:本站除部分特别声明禁止转载的专稿外的其他文章可以自由转载,但请务必注明出处和原始作
- 者.文章版权归文章原始作者所有.对于被本站转载文章的个人和网站,我们表示深深的谢意。如果本站转
- 载的文章有版权问题请联系编辑人员,我们尽快予以更正. 转载请注明来源:http://www.hackhome.com
上一篇:非主流文字的小议
下一篇:让某个页面使用特定的CSS的技巧
精品推荐
热点TOP10
- ·PHP环境配置介绍
- ·为什么打开网页那么慢?
- ·php中Cookie及其使用
- ·制作网站的步骤和方法
- ·初学者入门:如何学习网页制作?
- ·素材网站、优秀设计素材大全
- ·1394网络适配器是什么东西?
- ·PHP IDE 集锦
- ·魔兽世界私服建设初学者必看 建服资料
- ·网页设计制作试题及参考答案
- ·2006年100款最佳安全工具谱
- ·ADSL登录是错误,出现691是什么意思
- ·一段代码实现 一个空间做两个网站
- ·常见弹出代码集合
- ·这个软件是什么啊?
- ·国外一组精美网页设计欣赏
- ·免费采集规则活动之:跟我学新云采集入门
- ·知道对方的ip地址,如何查具体物理地址?
- ·网站地图制作工具
- ·几种调用WebService的方法
特别推荐
- ·网页制作过程中应代码注释书写要注意的问题
- ·网页设计的步骤和交流
- ·符合web标准的重要性!
- ·网页源代码查看的2种方式
- ·设计能力提升的好办法
- ·iframe透明的解决办法
- ·制作网页应该注意的5个问题
- ·栅格就是你对页面版式的规划
- ·网页设计:脚本素材重构用户体验
- ·网页制作关于代码的18个小技巧
- ·网页设计的尺寸和网页广告的规则
- ·网页制作关于代码的小技巧
- ·怎么重做系统
- ·网站性能:图片和Coockie以及移动应用的优化
- ·网页设计者优化网页速度的技巧
- ·网页设计者应该从三个方面优化网页
- ·网站策划:网站栏目和页面的策划
- ·教您制作出非常美观的网页
- ·每个Web站点都必需的十余个文件
- ·ARP攻击原理及解决方法
