None
NO
5 Things Learned Generating API Documentation
['Den Delimarsky']
Hi, I'm Den 👋 on Den Delimarsky
Now, if you are writing code just for yourself, API documentation might not be as important; however, once you start working with larger organizations and more serious APIs, the lack of quality API documentation becomes a BIG problem. Now, when I say “writing documentation”, in this context I am referring to documentation written in the product code (aka code comments) - I have no significant experience working with non-autogenerated documentation, so this will likely not apply to you if that’s what you do. API documentation generation tools are typically geared at addressing one key scenario - create documentation in a way that maps 1:1 to the code.