No More Posting New Topics!

If you have a question or an issue, please start a thread in our Github Discussions Forum.
This forum is closed for new threads/ topics.

Navigation

    Quasar Framework

    • Login
    • Search
    • Categories
    • Recent
    • Tags
    • Popular
    • Users
    • Groups
    • Search

    Best tool/approach for generating docs from code

    Framework
    3
    3
    183
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • FrankRuss
      FrankRuss last edited by

      What would be the best/recommended method for generating docs from comments in the code?

      I am aware of vuese.

      What would be your recommendation?

      qyloxe 1 Reply Last reply Reply Quote 0
      • s.molinari
        s.molinari last edited by

        There is also vue-styleguidist. Never used it. I just found it. 😃

        Scott

        1 Reply Last reply Reply Quote 0
        • qyloxe
          qyloxe @FrankRuss last edited by

          @FrankRuss And who will read those docs? For example if they are “your” developers then maybe docs from code are OK. If they are “other” developers then maybe something like OpenAPI (previously Swagger) would be better. I’m thinking about something like in Python’s FastAPI:
          https://fastapi.tiangolo.com/#interactive-api-docs
          But I don’t know if there exists something similar for javascript. Probably yes, it just needs finding as always. Assuming it would help in your use case, of course.

          1 Reply Last reply Reply Quote 0
          • First post
            Last post