Netbeans 4.1: JavaDoc comment for package ?

Hi there,

I'm almost done finishing up the first beta release of my (study) project and
so the time was come to dive more deeper into commenting. On a side note I have
to say considering Javadoc very appealing.

Alas, after having made the (obvious?) mistake of commenting my package and
discovering that this didn't work I read up on package-info.java and
package.html for commenting the whole package. Unfortunatly I couldn't make
Netbeans accept package-info.java so I resorted to the html file. While this
works excellent when it comes to Javadoc it also results in the html file being
included in my final jar distribution file. While this isn't a major problem I
don't consider it good practice...

So now I'm wondering if there is cleaner way in Netbeans to provide a Javadoc
comment for the entire package. Have I overlooked the obvious with
'package-info.java' or is there another option I could use ?

I was considering to see if I could make it ignore the package.html file when
building but I haven't come that far yet.


Thanks in advance for your comments.

--
Groetjes, Peter

..\\ PGP/GPG key: http://www.catslair.org/pubkey.asc
.

Relevant Pages

  • Re: Documentation manager?
    ... Eh, something like javadoc, parses comments and then generates an html file ...
    (microsoft.public.vb.general.discussion)
  • Commenting in Java
    ... Javadoc comments are for permanent API documentation ... Non-Javadoc comments are for the programmer to read and understand ... Professional programmers write flow commenting style (informal step ... Read the article on Literate programming at Wikipedia ...
    (comp.lang.java.programmer)
  • But is it beautiful code?
    ... package similar to the one I posted in 1990. ... pronounced it beautiful code, mostly, I gather because it almost ... commenting and variable naming. ... The new code style can be ...
    (comp.programming)
  • Re: ENOUGH about the "kids"
    ... My friends at the show couldn't stop ... commenting about how the Bunny costume was stuffed so that his ... "package" could be seen from 30 rows up. ...
    (rec.arts.marching.drumcorps)
  • Rake Hates Me Today
    ... I'm trying to package up a new gem to release, ... Commenting out the need_... ... need the archives too. ...
    (comp.lang.ruby)