给CSS代码四种注释加点规则
导读:CSS代按码注释写法不是乱搞的,当你在键盘上按下注释键那一刻时,就可以发现,其实注释是有规范的。今天我就来捋一捋这些注释的规则。 一、单行注释 注意到了,单选注释时,星号必须和内容保留一个空格。 二、多行注释 看出来了,星号要对齐,星号...
CSS代按码注释写法不是乱搞的,当你在键盘上按下注释键那一刻时,就可以发现,其实注释是有规范的。今天我就来捋一捋这些注释的规则。
一、单行注释
注意到了,单选注释时,星号必须和内容保留一个空格。
二、多行注释
看出来了,星号要对齐,星号和内容之间必须保留一个空格。
三、块内注释
块内注释,比如SCSS文件里就可以这么注释,也需要注意,//后面加上一个空格,注释独立一行。
四、文件注释
一般文件顶部必须包含详细的文件注释,这样另一个人查看时才顺手。甚至自己今后翻看时也能更清晰。上面看出,用@name标识文件说明,星号要一列对齐,星号与内容之间必须保留一个空格,标识符冒号与内容之间必须保留一个空格。
其中@update为可选项,建议每次改动都更新一下。
当该业务项目主要由固定的几个人负责时,另外要添加@author,写上作者名称。一方面,尊重劳动成果。另一方面方便在需要时快速责任人。
总结一下:
这些规则很容易被忽略掉,好的注释能大大提高代码的质量,同时JS文件也适应。
声明:本文内容由网友自发贡献,本站不承担相应法律责任。对本内容有异议或投诉,请联系2913721942#qq.com核实处理,我们将尽快回复您,谢谢合作!
若转载请注明出处: 给CSS代码四种注释加点规则
本文地址: https://pptw.com/jishu/666475.html