On Fri, 5 Apr 2002 10:48, Leif Mortenson wrote:
> Eung-ju Park wrote:
> >>I was thinking about what should be the minimum requirements for us to
> >>release a component from excalibur. I was thinking that the following
> >
> >would
> >
> >>be good as minimum requirements.
> >>
> >>* must pass checkstyle with 0 violations (which basically means lots more
> >>javadocing)
> >
> >Javadocing all method of implementation class is painful to me.
> >I already javadocing Cache interface. But checkstyle need javadoing all
> >method
> >of AbstractCache, ValidatingCache, SynchronizedCache, LRUCache...
> >Are we must pass checkstyle with 0 violations?
> >
> >All other requirements is good.
> >
> :-) I know that it is difficult, but remember that without all of the
>
> javadocs, it is very difficult for
> someone else to use the classes correctly and understand how to create
> them. Remember that
> there are lots of people willing to help out improving the javadocs
> later once there is something
> to work with. So please make at attempt at them.
Another thing I do that seems to work well. Javadoc the interface and then in
all the implementations do a
@see MyInterface#myMethod
so that majority of documentation is in interface and linked from the impl.
Then you just add in implementation documentation in the impl class.
--
Cheers,
Pete
---------------------------------------------------
"Marriage, Friends, Religon -- these are the demons
you must slay in order to suceed in business.."
-- Mr. Burns, The Simpsons
---------------------------------------------------
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
