vue文件中如何注释?

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

html 注释:

<!-- 注释,单行或多行 -->

CSS注释:

/*
    多行注释
 */

js 注释:

// 单行注释
/*
多行注释
多行注释
*/
var a = 'abc'; // 行末注释

xml 注释:

<!-- 注释,单行或多行 -->

文件注释规范

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

<!--
 * @FileDescription: 该文件的描述信息
 * @Author: 作者信息
 * @Date: 文件创建时间
 * @LastEditors: 最后更新作者
 * @LastEditTime: 最后更新时间
 -->

效果:

1.png

方法注释规范

VUE文件中method中的方法注释

 /**
  * @description: 方法描述
  * @param {参数类型} 参数名称
  * @param {参数类型} 参数名称
  * @return 没有返回信息写 void / 有返回信息 {返回类型} 描述信息
  */

效果:

2.png

3.png

4.png

变量的注释

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

5.png

或者

6.png

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

行内注释和代码块的注释

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

代码块的注释:

8.png

或者

9.png

行级代码的注释

11.png

其他

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

10.png

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

12.png

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

以上就是vue文件中如何注释?的详细内容,更多请关注web前端其它相关文章!

赞(0) 打赏
未经允许不得转载:web前端首页 » Vue.js 答疑

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

前端开发相关广告投放 更专业 更精准

联系我们

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏