doc.project java,如何为Java Project制作文档。

Hi all,

I''ve been involved in a project which is in the middle of the maintainance phase. The project is carried out in Hibernate(the most popular ORM technology). I am involved in the programming side as well as documentation part. I googled many days for proper ways for documentation but in vein. Is there any proper ways to carry out documentation for such project. Please do give me favor and help me in this regard.

Thanx in advance.

-Satyam

解决方案If you are after documentation of the code artifacts, then use the standard javadocs. If you read any java API docs they are all generated fromt he javadoc around the code. At a simple level:

/**

* This is the javadoc documentaion for the method.

* With added cheese!

*/

public void theMethod()

{

// stuff

}

I''m not talking about the code level documentation, i need the documentation from the system analysis level i.e. like Use Case,DFD etc. since ORM is Object to Relational Database Mapping technology, i''m finding the documentation of my project a bit challenging. so please suggest any method for documentation.

Hi,

You can try Javadoc command over command prompt.

put appropriate comments like Documentation comments.

than in optional parameter give either of this based on package[- public/private/protected]

map your class directory first.

and give *.* you will get documenation.

For more try javadoc over command prompt

regards.