hello,
my theory on this is that the JSP author is the consumer of pre-established JavaBeans and taglibs. the JSP author needs to read javadocs and consume the related java classes, as opposed to creating javadoc comments and classes for other consumers. the code that needs the javadoc comments, would actually be in the bean or taglib being consumed, not the jsp.
additionally, functionality that is encapsulated into a javabean is reuseable by any other jsp authors. so, according to my thinking, your method: MyServletWhichIsAJSP() should really be in a javabean, and that javabean should have the javadoc comments, to explain how it should be used. the javadoc tool can be easily used on a javabean, but i am not sure about tag libs. it seems like a valuable function, so i would imagine some facility for taglibs is forthcoming, but, if that is the whole point of your posting, im probably not helping much.
of course, there should still be comments in the JSP, to explain the jsp code to the person maintaining the page in the future. but, i dont think there is much of a need to publish these comments...
-----Original Message-----
From: Herzog Bernhard [mailto:[EMAIL PROTECTED]]
Sent: Monday, November 29, 1999 7:37 AM
To: [EMAIL PROTECTED]
Subject: Comment JSPs - Best Method
Hi,
I want to create comments inside my JSPs. Esp. I have
some JSPs with in-parameters (get/setAttribute). I include these into
other JSPs. I would prefer to have javadoc comments like in Java
classes so I can use javadoc to create HTML documentation:
/**
* Some comments about my JSP and its parameters here.
*/
public class MyServletWhichIsAJSP
{
}
But I do not know how this is possible with the JSP technology.
And if that is not possible - what is the best way for comments which
can be easily extracted by a javadoc-like tool? Will Tag-Libraries in
the future have a facility to automate this?
TIA
Bernhard
===========================================================================
To unsubscribe: mailto [EMAIL PROTECTED] with body: "signoff JSP-INTEREST".
FAQs on JSP can be found at:
http://java.sun.com/products/jsp/faq.html
http://www.esperanto.org.nz/jsp/jspfaq.html
