I am struggling right now with how to properly and efficently document
my Struts application for my JSP developer (who is by no means a Java
expert). Specifically, I want to document each Action as well as each
ActionForm that I code, including things like:
1. the pages I expect the user to have come from
2. the pages to which I might forward, or redirect, the user after
completing the action
3. The beans I expect to be in place prior to submitting to my action
4. The beans I will set up with values for the resulting JSP page to
work with
5. The errors (<html:errors>) I may set up
And anything else that might be appropriate. I'd like to do so in a way
that lets me rely on Javadoc, so that I can keep my documentation inside
my code. Javadoc when used correctly will also let me do things like
"see also" the Bean documentation (from the Action documentation).
I am curious if anyone has developed a "template" action or bean, which
makes best use of Javadoc and which I can cut-and-paste at the head of
every one of my Action classes, etc?
Thanks,
Bryan
