How to make documentation for Java Project.

Question

0.00/5 (No votes)

See more:

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

Posted 27-Jan-10 19:00pm

Satyam182

Add a Solution

3 solutions

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Nagy Vilmos · Answer 1 · 2010-01-27T23:54:00

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

}

Satyam182 · Answer 2 · 2010-01-28T00:11:00

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.

AminJigar · Answer 3 · 2010-01-29T03:23:00

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.

How to make documentation for Java Project.

3 solutions

Solution 1

Solution 2

Solution 3

Add your solution here

Preview 0