Self Documenting Code
Despite what you think about your code, it is not self documenting. When
writing code add comments, describe what a function does, explain why
you're using that convoluted pointer arithmetic and bit shifting. I'm
sure it makes sense now, but someday you'll have to go back and look at
it and figure out what the hell you were doing. Or worse, I'll
have to go back and look at it and figure out what the hell you were
doing.
Sometimes it is important to have some sort of separate documentation
for the code; maybe some UML or ER diagrams, maybe some English text.
Use what ever it takes to explain what you were doing. Do not paste
snippets of your code into the text and call it documentation.That
is not documentation, that is code.
writebacks...
trackback
TrackBack ping me at:
http://www.rainysoul.net/~mforde/blog/index.pl.trackback
comment...