I write inline documentation. It's usually headerdoc-style stuff. Tools like Jazzy, DocC, and Doxygen make it very useful[0].
I'll often write the documentation before the functionality. When I'm done, I run Jazzy, and I have an indexed, navigable, relevant, up-to-date document set. I point GH Pages at it, and voila! You have a well-documented codebase.
It also encourages brevity and keeps the focus local.
I'll often write the documentation before the functionality. When I'm done, I run Jazzy, and I have an indexed, navigable, relevant, up-to-date document set. I point GH Pages at it, and voila! You have a well-documented codebase.
It also encourages brevity and keeps the focus local.
[0] https://littlegreenviper.com/miscellany/leaving-a-legacy/