3 ms·
Well, consider that such documentation is often generated from comments.
by emodendroket 5y ago
Well, consider that such documentation is often generated from comments.
- mattacular 5y agoFair enough. I will say my recommendation is for writing useful inline comments ("the why" comments and more rarely "the what"). File-level and function-header type comments that tend to generate docs (eg. Doxygen) are certainly more likely to fall out of date (easy to miss in a PR diff etc) and I don't really support using them anyway.