Recommendation for generating documentation?

  • I’ve used documentation generators ages ago, and my team would like to generate documentation for our Quasar projects. The only thing I’ve come across that looks like it might work is jsdoc plus the vue plugin. But it doesn’t seem like that alone will work with Quasar due to the unique structure and features added.

    Do you guys have any recommendations? If you’ve used jsdoc, do you know how we could get it to properly document Quasar stuff?

  • I have used JSDoc, and its good. Document your functions like any other JS. Some people might tell you to use typescript, as it is “self-documenting”, but I still think that having a JSDoc type reference is good thing.

  • Looking into that. Thanks.

Log in to reply