Best tool/approach for generating docs from code
-
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?
-
There is also vue-styleguidist. Never used it. I just found it.
Scott
-
@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.