成都网站建设|域名注册|虚拟主机|网站制作|网站案例|网站优化|网站推广|企业邮局|服务器租用|广告设计
良好的代码编写风格能够帮助我们在制作网页的时候思路清晰,其中代码的注释也有一些小的学问。注释书写规范,其实也没有什么技术含量,主要是注意规范,便于统一制作方式,也方便维护。 这些经验包含“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。大部分朋友使用的区域注释的方法会以“注释内容开始”或“注释内容结束”、“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{ /*注释内容[修改人和修改时间]*/