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

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

ID:50468942

大小:32.02 KB

页数:3页

时间:2020-03-09

网页制作过程中代码注释书写规范.doc_第1页
网页制作过程中代码注释书写规范.doc_第2页
网页制作过程中代码注释书写规范.doc_第3页
资源描述:

《网页制作过程中代码注释书写规范.doc》由会员上传分享,免费在线阅读,更多相关内容在学术论文-天天文库

1、网页制作过程中代码注释书写规范点评:总结了一下自己工作中使用到的注释书写规范,没有什么技术含量,只是用于统一制作方式,方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。大部分同学使用的区域注释的方法,会以“注释总结了一下自己工作中使用到的注释书写规范,没有什么技术含量,只是用于统一制作方式,方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。大部分同学使用的区域注释的方法,会以“注释内容开始”或“注释内容结束”、“start”或“end”等,相比之

2、下,以“S”或“E”开始可以更快的使用,比如只要写一次开始或结束的注释,然后复制,改下“S”或“E”就可以快速的完成区域的注释。区域注释在实际工作中,有时会出现分不清注释应该在标签之上还是标签之下,为了避免这种情况,注释信息统一写在区域标签开始之前和结束之后,并以“S”或“E”开始,表示区域注释的开始或结束。例:

...
/*=S注释内容*/.class{...}.class{...}/*=E注释内容*/单行注释注释信息应写在需注释的内

3、容区域里例:

...
.class{/*注释内容*/...}注释层级在模块制作中,可能会出现区域中还有区域的情况,为了更好的区分区域之间的层级,引入了注释层级的概念。区域注释前面的等号表示了当前注释的层级例:.............../*=S注释内容*/.../*==S注释内容*/.../*===

4、S注释内容*/.../*===E注释内容*/.../*==E注释内容*/.../*=E注释内容*/协助注释非作者维护时所加入的表示修改时间、修改人等标识信息。在区域注释或单行注释的基础上加上修改人和修改时间等信息。例(区域注释):

...
/*=S注释内容[修改人和修改时间]*/.class{...}.class{...}/*=E注释内容[修改人和修改时间]*/例(单行注释):

5、-注释内容[修改人和修改时间]-->...

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

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。