Re:Your Code is Not Self Documenting
by beoba on Sunday January 09, 2011 @09:57PM
(#2087253)
I think you're mixing up inline documentation with api documentation.
For inline stuff where it's explaining a complex/dense lump of code, it's useful to keep it as close to the original code as possible, so that if somebody updates the code, they're more likely to see/update the comments as well.
For inline stuff where it's explaining a complex/dense lump of code, it's useful to keep it as close to the original code as possible, so that if somebody updates the code, they're more likely to see/update the comments as well.