This is directly contrary to best practices. What really would have
helped in Struts would have been if someone had discussed some of the
naming conventions prior to committing them. They are particularly
bad in Struts. However, best practices is to make the code clear
first. If that is not possible, only then comment. OP
On 9/29/05, Murray Collingwood <[EMAIL PROTECTED]> wrote:
> I agree with Frank, we all started with Java/Struts somewhere and back then
> the more
> comments in the code made it so much easier for us to understand. The people
> who
> come after us will also be learning, let's make it easier for them.
>
> The only time you should reduce comments is when your compiler times-out while
> parsing your source code.
>
> Kind regards
> mc
>
> On 29 Sep 2005 at 12:20, Frank W. Zammetti wrote:
>
> > On Thu, September 29, 2005 11:57 am, Dave Newton said:
> > > Oh god remove the comments. Bottom line: if someone can't figure out
> > > what's going on here w/o relying on the comments then they're fired.
> >
> > Well now, *this* is a good way to go off-topic in a hurry Dave! :)
> >
> > I personally feel just the opposite... the more comments the better, and I
> > don't generally care how "pointless" they are... well, ok, if I see:
> >
> > a++; // Add 1 to A
> >
> > ... I tend to groan rather loudly, but that's a bit extreme :) When your
> > talking about all the myriad classes available in Java, it's virtually
> > impossible to remember them all, what their methods do, etc.
> >
> > For instance, take this line:
> >
> > String s = s1.toUpperCase().trim().replace('A', '-');
> >
> > Now, that's pretty straight-forward. But, if someone added a comment:
> >
> > // Convert s1 to all upper-case, trim whitespace from both ends and
> > replace all A's with -'s and store result in s
> >
> > I wouldn't frown upon that for two reasons... one, me looking at it
> > doesn't have to remember what replace() does (i.e., does it replace ALL
> > occurances of 'A' or just the first?) and two, it indicates that the
> > developer who wrote it knew what he intended to do and wrote the code
> > accordingly.
> >
> > So for me, the more comments the better, even if they are commenting on
> > what is an obvious thing for most.
> >
> > Frank
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: [EMAIL PROTECTED]
> > For additional commands, e-mail: [EMAIL PROTECTED]
> >
> >
> >
> > --
> > No virus found in this incoming message.
> > Checked by AVG Anti-Virus.
> > Version: 7.0.344 / Virus Database: 267.11.8/114 - Release Date: 28/09/2005
> >
>
>
>
> FOCUS Computing
> Mob: 0415 24 26 24
> [EMAIL PROTECTED]
> http://www.focus-computing.com.au
>
>
>
> --
> No virus found in this outgoing message.
> Checked by AVG Anti-Virus.
> Version: 7.0.344 / Virus Database: 267.11.8/114 - Release Date: 28/09/2005
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [EMAIL PROTECTED]
> For additional commands, e-mail: [EMAIL PROTECTED]
>
>
--
"You can lead a horse to water but you cannot make it float on its back."
~Dakota Jack~
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
