documentation for Quasar projects
-
I am new to Quasar and wanted to document my code with something like vueStyleguidist or jsdocs.
After losing a few days in trying to get it working I realize I need some help.
As Quasar is very complete, I am surprized this is not included in the framework.
Or am I missing something?
Could you give me some tips on how I can fix this? Has somebody a guide to install it on Quasar?
Thanks -
Usually IDE’s like VSCode and Webstorm have plugins to create docs.
Vscode:
https://marketplace.visualstudio.com/search?term=jsdoc&target=VSCode&category=Other&sortBy=RelevanceWebstorm:
https://www.jetbrains.com/help/webstorm/creating-jsdoc-comments.htmlpersonally I find puting comments in code a very bad practice.
-
@dobbel I understand you find comments in code bad practice. Can you recommend a method, that makes it easy and makes a good practice to document? My experience is that doing the docs in a seperate system is not easy to maintain.
Thanks for the links. -
UML! No just kidding , I cannot recommend a document system. Ideally the code itself should be self explanatory.
You could listen what Uncle Bob has to say about comments in code:
(The series is about clean code, very informative, has a section about comments )
https://www.youtube.com/watch?v=7EmboKQH8lM
