[thelist] project documentation
Rob Smith
rob.smith at THERMON.com
Wed Apr 2 16:33:53 CST 2003
> Hi, Ken --
>
> You wrote:
>
>>Right now, I'm trying to write the style guide for them, and it's not
>>easy... Why can't project documentation just go away and everyone start
>>thinking like me? :)
I second that notion. I'll admit that I'm guilty of "spaghetti code". A
college professor once told me that fancy documentation was telling *him
that your code was perfect and you had time to play around with
documentation:
' ###################################
' ### -=|=-=|=-=|=-=|=-=|=- ###
' ## Sample Documentation ##
' # -=|=-=|=-=|=-=|=-=|=- #
' ## ##
' ### blah blah blah ###
' ## blah blah blah ##
' # blah blah blah #
' ## ___ ##
' ### ----000'*v*'000---- ###
' ###################################
But the fact of the matter is that you usually don't have time for
documentation. I rarely do.
rambling...
Rob.Smith
More information about the thelist
mailing list