Is there a de facto standard documentor for Javascript?
I’m trying to document my code using JSDOC3, that has a similar syntax to PHPDocumentator / Apigen. But is there a de-facto standard for Javascript inline documentation? I think Google Closure is the most complete (or so it seems), but what is widely adopted by IDEs and what most people expect to the docs to be?
Standardized code documentation format, where is it? [closed]
Closed 5 years ago.
Standardized code documentation format, where is it? [closed]
Closed 5 years ago.
Standardized code documentation format, where is it? [closed]
Closed 5 years ago.
Standardized code documentation format, where is it? [closed]
Closed 5 years ago.
Standardized code documentation format, where is it? [closed]
Closed 5 years ago.
Shouldn’t documentation be written together with tests rather than in the code?
It is popular to write documentation in the same file as the code and extract that using software to generate documents. In order to not affect performance, the documentation is written within commented lines, in a DSL designed just for the purpose of that. And that often results in cumbersome source file.
Are comments obsolete in favor of Generative AI?
With generative AI, you can just ask it to explain the code to you. In my experience, it is reliable and accurate – which cannot always be said about manual comments. I am specifically referring to comments on signatures – not necessarily inline comments, TODOs, or things of that nature.
Are comments obsolete?
With generative AI, you can just ask it to explain the code to you. In my experience, it is reliable and accurate – which cannot always be said about manual comments. I am specifically referring to comments on signatures – not necessarily inline comments, TODOs, or things of that nature.