自动生成vue项目文档

tools vuese

tools

发布日期: 2022-02-20

作者: 宋宇

文章字数: 190

阅读时长: 1 分

阅读次数:

官网地址

简单使用

安装

npm i -g @vuese/cli

生成

任意一个vue项目，执行：vuese gen生成一个website目录

启动

执行：vuese serve --open启动文档服务，浏览器中可查

使用心得

默认只支持编程封装的自定义组件，如果是独立使用的组件，它默认是不给生成的。需要这样写。
```
<script>
  // @vuese
  export default {

  }
</script>
```
不能对data，生命周期，计算属性做文档编译，只有slot，props，methods和mixins做文档编译。

这里给一份我用的示例

// @vuese
// @group Goods
export default {
  props: {
    // username
    username: {
      type: String,
      required: true,
      default: ""
    }
  },
  methods: {
    /* 
      @vuese
      登陆方法
      @arg  { username, password }
     */
     submit() {}
  }
}