DEV Community

Discussion on: The Four Layers to Great Documentation

Collapse
 
nicolasbonnici profile image
Nicolas Bonnici

You can also parse your API controller method annotations and generate on the fly the documentation. It will update with your code so no need to mai tain it at each API update.

Collapse
 
ojkelly profile image
Owen Kelly

Absolutely. API documentation can come auto-generated from well written source code documentation (javadoc, jsdoc, phpdoc, godoc, etc).

But only the API documentation should be auto-generated.

Collapse
 
ekimkael profile image
Ekim Kael

But i don't know why every auto-generated doc i've read wasn't good