>>>>> "J" == Jon Stevens <[EMAIL PROTECTED]> writes:
J> Great suggestions! I eagerly await your documentation. :-)
Careful what you wish for, you just might get it :)
I've actually thought of doing this; it wouldn't be too awfully
hard to regexp hunt for data 'set*' calls, then C-x` to step
through them all and C-c C-v j to javadoc the method.
I was thinking, though, more along the lines of "When you fix any
function, please fix the javadocs too" having a prominent part of your
strict style guide ;) After all, how many times a week do we
collectively tweak the code? How much time does it take to add just
one line of javadoc every time we do this?
Like many things in life, it takes more time and effort to avoid
documentation (and be doomed to answer the same questions over and
over) than to just include it in our habits and be done with it,
especially when we already know how the code works.
Lest we wander the sad way of the gnostics ... :)
Ok, how's this for a starter: You'd mentioned the programmer style
guide in the context of submitting diff -u patches, and I've got
text left over from the similar doc from the Linux kernel style
and submission guide. What say I merge these as a starting point?
--
Gary Lawrence Murphy <[EMAIL PROTECTED]> TeleDynamics Communications Inc
Business Innovations Through Open Source Systems: http://www.teledyn.com
"Computers are useless. They can only give you answers."(Pablo Picasso)
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
