如何注释html、css、js代码

JavaScript017

如何注释html、css、js代码,第1张

不是每行代号都需要注释，但注释代码量要占10% ~ 20%，以免其他人在检测调试代码的时候，不知道这段代码是什么意思，还得从前面开始理解代码，增加别人的工作量。下面，我们来看看如何注释html、css、js代码吧。

01

html注释的格式

html注释的格式是【 <!--代码块-->】，把注释的内容写在“<!--”和“-->”里面就可以了。这个表示多行或单行注释。

　<!--这里写这个元素的层级、包含的大致内容、这个区域的名称-->

02

html注释的快捷键

在sublime编辑代码的时候，可以使用快捷键组合【 ctrl+shift+/ 】来注释代码。

03

css注释的格式

CSS注释的格式是【/* 注释内容 */】

04

js注释的格式

js注射的格式是【// js代码】

1、JS的注释一般是双斜杠 //  或者是 /**/ 这样的块注释；而.json 是配置文件，其内容必须符合JSON格式，所以文件内部不允许有注释。

2、app.json 是全局配置文件，微信小程序中的每一个页面的【路径+页面名】都需要写在 app.json 的 pages 中，且 pages 中的第一个页面是小程序的首页 。

注意事项：

1、.wxss 文件是样式表文件，app.wxss是全局的样式表文件。页面的样式表是非必要的。当有页面样式表时，页面的样式表中的样式规则会层叠覆盖 app.wxss 中的样式规则。如果不指定页面的样式表，也可以在页面的结构文件中直接使用 app.wxss 中指定的样式规则。 .json 文件具有相同的规则。 每一个页面的路径名和文件名必须相同。

2、.tabBar（客户端窗口的底部用于切换页面的tab栏）在 app.json 文件中配置，只能配置最少2个、最多5个 tab，显示顺序同tabBar标签下的pei 。

3、 tabBar 的 iconPath 和 selectedIconPath 属性可以接受一个图片的路径，这个图片必须是本地图片不能是网络图片。

4、像素单位最好使用 rpx ，微信会根据手机屏幕大小自适应。 微信小程序存放资源文件，需要在根目录下创建文件夹，引用时以 /文件夹名/资源名 的形式引用。

5、一个应用同时只能打开5个页面。wx.navigateTo 打开页面不会销毁之前的页面，如果页面层数较多注意使用 wx.redirectTo。

你想直接通过 /* */ 来进行块级代码注释是不可行了，只能通过变通的方式。比如将结束 */ 改成 *\/ ，避免提前拦截。

其实用双斜线 // 挺好的。你觉得代码量多，那是因为你想的是手动去一行行注释。 现在的开发编辑器都是自带注释快捷键的，选中之后一键注释就行了。

比如我用的 vs code 编辑器，注释和取消注释都是按 'Ctrl+/' ，很方便