Vue 项目注释规范

1,022 阅读1分钟

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

文件注释规范

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

方法注释规范

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

参考自Vue 项目注释规范 - 掘金 (juejin.cn)