网站注释代码的写法
网站制作过程中,可能需要对网站的一些代码进行注释。以便自己书写的代码可以给别人看清,或者被别人正确理解。那么,如何保证好的网站注释代码呢?下面笔者就来具体介绍下。
操作方法
- 01
在写注释代码的时候。我们可以用“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。大部分朋友使用的区域注释的方法会以“注释内容开始”或“注释内容结束”、“start”或“end”等,相比之下,以“S”或“E”开始可以更快的使用。因为毕竟注释代码的时间越少越好。
- 02
单行注释 单行注释的信息应写在需注释的内容区域里。 例: <div> <!--注释内容--> ... </div>
- 03
区域注释 在实际工作中,有时会出现分不清注释应该在标签之上还是标签之下,为了避免这种情况,注释信息统一写在区域标签开始之前和结束之后,并以“S”或“E”开始,表示区域注释的开始或结束。 例: <!--=S 注释内容--> <div> ... </div> <!--=E 注释内容-->
- 04
注释层级 在模块制作中,可能会出现区域中还有区域的情况,为了更好的区分区域之间的层级,引入了注释层级的概念。区域注释前面的等号表示了当前注释的层级 例: <!--1S 注释内容--> ... <!--2S 注释内容--> ... <!--3S 注释内容--> ... <!-3E 注释内容--> ... <!--2E 注释内容--> ... <!--1E 注释内容-->
- 05
通过这样的办法,也可以将注释的层级进行区分。
赞 (0)