What's a good code documentation tool?
Is there a tool that automates code documentation for you out there? I would like to get the structure of the mountain of code I have similar to this:
https://docs.woocommerce.com/wc-apidocs/class-WC_Abstract_Order.html
So I don't have to scroll through mountains of code when reviewing certain things.
Preferences: PHP and React.js
Thanks.
Trending on Indie Hackers
Postman has a nice feature that allows you to automatically generate API documentation based on your tests. It's such a time-saver.
https://www.getpostman.com/
https://www.youtube.com/watch?v=Ayo_KdLLcTA
I use Postman https://www.getpostman.com/
Docusaurus is an awesome tool/platform for documentation. It uses react and markdown to write everything: https://docusaurus.io/
If you’re documenting API’s, I’ve used Swagger open api specification for writing those docs in yaml. Then I use Redoc to display the yaml into a UI.
Because Redoc is React it can also be embeded in Docusaurus.
https://swagger.io/specification/
https://github.com/Redocly/redoc
https://github.com/slatedocs/slate maybe?
What language do you use? Javadoc (for Java) and those inspired by it (for other languages) tend to be pretty powerful syntaxes for inline documentation of code. Many tools exist, depending on the language you are developing in, to take all of the Javadoc or similar comments in your code and generate HTML documentation off of them at build time.
My usual stack is the traditional LAMP setup. PHP and React.js my go-to focus.