aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Javadoc class documentation Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Javadoc class documentation" Watch "Javadoc class documentation" New topic
Author

Javadoc class documentation

Chris Hani
Ranch Hand

Joined: Jun 03, 2004
Posts: 42
Hi, all~~

I just finished a small part(reading database file -- of the project and try to write comment not to forget what I have done.

My questions are,
1. What is "a full set of documentation"?
In my spec(B&S 2.3.2) there is a statement, "You must create a full suite of documentation for the classes of the completed proeject"

2. Shall I write comments for private member fields also?

Hmm, I guess the most hardest part in this project is documentation.
Olena Golub
Ranch Hand

Joined: Jan 17, 2005
Posts: 113
Originally posted by Sung Kum Her:
[QB]Hi, all~~
1. What is "a full set of documentation"?
In my spec(B&S 2.3.2) there is a statement, "You must create a full suite of documentation for the classes of the completed proeject"


If you look at your specification, it has surely after this sentence the another one

"This must be generated using the tool "javadoc" �"

I think that the whole code documentation (javadoc) was meant here.


2. Shall I write comments for private member fields also?

I would recommend you to write comments also for private member. Because it helps easy understand the code:


"A clear design, such as will be readily understood by junior programmer�"



I don�t like to write documentation too; especially write in English, because it�s not my native language But we should clench the teeth together and complete SCJD
[ March 31, 2005: Message edited by: Olena Golub ]

SCJP 1.4<br />SCJD 1.4 (in progress)
Jeroen Wenting
Ranch Hand

Joined: Oct 12, 2000
Posts: 5093
Documentation is the bane of every project I've ever worked on. Sun's on the right track to not only encourage it but make it an essential part of the certification requirements.
Might get a few people to do it more often

For example, on my current project the general attitude is "documentation, what's that?".


42
Paul Bourdeaux
Ranch Hand

Joined: May 24, 2004
Posts: 783
Jeroen,

I couldn't agree more. I really think Sun is smart to require documentation. All too often the person or team who maintains or upgrades code is not the same one who developed it. There is nothing worse than jumping into a major project that has 20+ packages and little or no documentation!


“Programming today is a race between software engineers striving to build bigger and better idiot-proof programs, and the Universe trying to produce bigger and better idiots. So far, the Universe is winning.” - Rich Cook
Jeroen Wenting
Ranch Hand

Joined: Oct 12, 2000
Posts: 5093
Worst case I ever had was a million line C++ application that had no documentation at all.
The only available docs were some class diagrams generated by the initial development team (since long gone of course) and 5 years out of date.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Javadoc class documentation