If I'm overriding a method from the super-class and the super-class has adequate
documentation. In JDK 1.4. we would use the {@inheritDoc} tag, in which case I would
withdraw my objection.
There are some times when I deliberately do not put in javadoc to describe a variable
that is
self-evident or obvious. Sometimes doing something like:
/**
Stuff
@param customerUserID the UserID of the customer
*/
Is basically useless. I'm not sure how much more interesting information I could put
about
customerUserID in the javadoc that would be useful to someone maintaining the code. I
could put internal information in the javadoc (i.e. We use the customerUserID as a key
to
the Customer Database table to look up other attributes related to the customer), but
that
also is self-evident in this particular system.
What information would you guys put in something like that?
Mike
On 6 Mar 2002 at 9:11, Thomas Singer wrote:
> How often you want to get an imcomplete JavaDoc comment? If you really
> want, you can define an live template for /** that extents on pressing
> <Tab>.
>
> For me it seems absolutely natural, that <Enter> expands it, because
> <Enter> expands the {, too, to a {}-pair.
>
> Tom
>
>
> At 17:38 05.03.02 -0500, you wrote:
> >Because there is no way to enter:
> >
> >/**
> >stuff
> >*/
> >
> >and NOT get the automatic template building mechanism.
> >
> >Mike
> >
> >
> >On 5 Mar 2002 at 9:53, Shane Petroff wrote:
> >
> > >
> > > Michael Kirby wrote:
> > >
> > > > That should be /** <tab>
> > > >
> > > > enter would become very annoying very quickly.
> > >
> > > I could live with either. Why do you think <enter> would be
> > > annoying?
> > >
> > > --
> > > Shane
> > >
> > >
> > >
> > > _______________________________________________
> > > Eap-features mailing list
> > > [EMAIL PROTECTED]
> > > http://www.intellij.com/mailman/listinfo/eap-features
> > >
> >
> >---
> >[EMAIL PROTECTED]
> >To obtain my PGP public key, mail "SEND PUB KEY" in the
> >subject to "[EMAIL PROTECTED]"
> >
> >
> >_______________________________________________
> >Eap-features mailing list
> >[EMAIL PROTECTED]
> >http://www.intellij.com/mailman/listinfo/eap-features
>
>
> _______________________________________________
> Eap-features mailing list
> [EMAIL PROTECTED]
> http://www.intellij.com/mailman/listinfo/eap-features
>
---
[EMAIL PROTECTED]
To obtain my PGP public key, mail "SEND PUB KEY" in the
subject to "[EMAIL PROTECTED]"
_______________________________________________
Eap-features mailing list
[EMAIL PROTECTED]
http://www.intellij.com/mailman/listinfo/eap-features
