File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes JSP and the fly likes JSP Documentation Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Java » JSP
Bookmark "JSP Documentation" Watch "JSP Documentation" New topic

JSP Documentation

John Ray Allen
Ranch Hand

Joined: Jan 06, 2005
Posts: 50
Can somebody explain & teach me how to make a proper JSP documentation? I have search alot of sites regarding on this matter but no one can tell me the exact contents or if there is any standards on how to make such documentation...Wanna hear your views regarding this matter guys...Thanks!
Gert Cuppens
Ranch Hand

Joined: Jul 13, 2003
Posts: 87
This depends on what you're doing with your JSP.
If you're following the MVC or Model-View-Controller Model 2, then your JSP's are merely showing data. If you're connecting to databases inside the JSP, I'd say you should change the way you've built your application.

With a JSP merely showing data, it can be sufficient to have some sequence diagrams in UML to show the flow of your application. For each JSP you can describe the data it is showing or accepting from the user.
I agree. Here's the link:
subject: JSP Documentation
It's not a secret anymore!