Jsdoc is a common tool used by the front end to automatically generate documents. We can write comments in jSDoc syntax and the result is a nice document.

However, jsdoc is for JS files, and.vue files seem to be helpless. But since VUE is so popular, I’m sure there will be a tool for it. After looking around, I found jsdoc-Vue written by a senior.

After a bit of research, this tool mainly solves the problem of jsDoc not recognizing.vue files. You can make.vue files automatically generate documents, but the resulting document style is not pretty. So Fork came in and gave it a makeover.

Without further ado, here is a screenshot of the generated document. Github address: Jsdoc-vue modified version

The main parts of the transformation are as follows:
  1. Using thejsdocDictionary, therefore can be usedjsdocOwn tags to write. This also makes it easy to generate the required templates.
  2. The generated document uses the Minami template
  3. Vue-template-complier and JSdoc modules have been upgraded
Installation and use method
git clone [email protected]:Konata9/jsdoc-vue.git

npm install 
Copy the code

I am satisfied with the modified version. Important components such as props and Components can be expressed clearly using jSDoc’s own syntax.

If you like, I hope you can click a star. Of course, if there is an improvement, I hope you can give advice.