5e8d6b228d8ca422.jpg

vue文件里是可以写注释的。在每个代码块内,注释的时候,需要使用各自语言的注释语法去注释(HTML、CSS、JavaScript、Jade 等)。在文件最顶部注释的时候用HTML的注释语法: 。

html 注释:

CSS注释:/*

多行注释

*/

js 注释:// 单行注释

/*

多行注释

多行注释

*/

var a = 'abc'; // 行末注释

xml 注释:

文件注释规范

单个文件注释规范,每个独立的VUE文件开头都要进行注释,表明该文件的描述信息、作者、创建时间等。

效果:

1586325888578597.png

方法注释规范

VUE文件中method中的方法注释/**

* @description: 方法描述

* @param {参数类型} 参数名称

* @param {参数类型} 参数名称

* @return 没有返回信息写 void / 有返回信息 {返回类型} 描述信息

*/

效果:

1586325975591441.png

1586325980520535.png

1586325985328363.png

变量的注释

vue文件中data声明的变量的注释:

1586326001903304.png

或者

1586326011820017.png

在变量的后面进行变量的注释说明,可以不行注释,当时最好注释(是否注释根据自己需要)

行内注释和代码块的注释

当我们在写一个比较复杂的方法的时候,需要进行注释,这时需要确定是否使用行级注释还代码块的注释

代码块的注释:

1586326077127996.png

或者

1586326086755707.png

行级代码的注释

1586326121391517.png

其他

当我我们在引用其他方法时,也需要进行引用,例如:

1586326099105123.png

当我们引入的方法过多时,要进行换行(换行标准自己定义)

1586326154138941.png

更多web前端开发知识,请查阅 HTML中文网 !!

Logo

前往低代码交流专区

更多推荐