Re: [JPP-Devel] Revised Comments For OpenJUMP Source Code File

2006-08-31 Thread Sunburned Surveyor
Thanks for your comments as well Stefan. I will consider them as I make my efforts to document some of OpenJUMP's source code. SS On 8/31/06, Stefan Steiniger <[EMAIL PROTECTED]> wrote: > once more i agree with Larry, > > your example doc is too detailed, because usually after half a year you > w

Re: [JPP-Devel] Revised Comments For OpenJUMP Source Code File

2006-08-31 Thread Stefan Steiniger
once more i agree with Larry, your example doc is too detailed, because usually after half a year you will be able to read normal method headers. (but i can remember that in the very beginning I also commented everything for myself .. but after 2 months..) Although i sometimes miss also good do

Re: [JPP-Devel] Revised Comments For OpenJUMP Source Code File

2006-08-31 Thread Sunburned Surveyor
Thanks for the constructive criticism Larry. :] I still like the detailed explanation, but you are right about including notes of the return value and parameters. I may remove those. I realize this is a style many programmers have a problem with. (But then again, that's probably why so many open

Re: [JPP-Devel] Revised Comments For OpenJUMP Source Code File

2006-08-31 Thread Larry Becker
Hi Sunburned,  Other developers may feel differently, but for me the comments you added are of the sort that many college programming instructors would find objectionable.  Many coders find that putting in comments that reiterate what the code already says unnecessarily clutters the source code. Th