Vue.js JSDoc 单文件 Vue 组件

我一直在用documentation.js来记录我的Vue文件.Here's an excellent article关于如何开始使用它.它的易用性给我留下了深刻的印象，它生成了好看的HTML文件，可以用来轻松搜索您编写的函数.

例如，如果您创建如下Vue文件:

<template>
    <div>{{mydata}}</div>
</template>

<script>
export default {
    data: function() {
        return {
            mydata: "hello"
        }
    },
    methods: {
        /**
         * Add two numbers.
         * @param{number} num1 The first number to add
         * @param{number} num2 The second number to add
         * @return{number} The sum of the two numbers.
         */
        addnums: function(num1, num2) {
            return num1 + num2;
        },

        /**
         * Concatenate two strings.
         * @param{string} str1 The first string to concatenate.
         * @param{string} str2 The second string to concatenate.
         * @return{string} The concatentation of the two strings.
         */
        concat: function(str1, str2) {
            return str1 + str2;
        }
    }
}
</script>

运行documentation build /path/to/file.vue -f html -o docs将创建一个漂亮的HTML文件，在浏览器中如下所示:

2019 EDIT:

我昨天发现了一个名为vuese的新库，它是专门为记录Vue组件而构建的.而文件.js将在帮助您记录方法方面做得很好，vuese通过允许您将文档添加到props 和组件中，更进一步.它非常容易使用.

我几乎从this blog post中学到了我需要知道的一切.