Re:Your Code is Not Self Documenting
by nostrademons on Sunday January 09, 2011 @10:43PM
(#2087368)
I don't usually have to stop and think for documentation, though. That's the idea - you're just putting down what's already in your head so that the maintainer can read it.
That said, I usually find that the documentation I write ends up becoming out-of-date about 5 minutes after I write it, because code changes in the process of writing it down. I might write down a docstring to clarify my thoughts, but then the function I actually write doesn't do exactly what I thought it would, and I have to go back and remove or cleanup the docstring later.
That said, I usually find that the documentation I write ends up becoming out-of-date about 5 minutes after I write it, because code changes in the process of writing it down. I might write down a docstring to clarify my thoughts, but then the function I actually write doesn't do exactly what I thought it would, and I have to go back and remove or cleanup the docstring later.