File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Documentation and other fun stuff 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 "Documentation and other fun stuff" Watch "Documentation and other fun stuff" New topic

Documentation and other fun stuff

Adam Roberts
Ranch Hand

Joined: Mar 18, 2002
Posts: 71
To those who have gotten full credit for their docs just a few quick questions.
1) Manuals : My manuals are *very* short. Executing the programs is the most difficult part and that is covered in README.txt . Especially for the server(Start rmiregistry, start server, take a nap, etc ) Any sort of input on the length of yours would be helpful
2) Comments : I only have say, 15-20 short one line(//) comments (not including javadoc). Too little? Just didnt find much to say that wasn't pretty obvious
3) Design - didnt get too wordy on this one either, maybe 1.5- 2 pages
Thanks in advance for dealing with my silly qs
:roll: :roll:

Adam Roberts - SCJP2, SCJD<br />insert witty something here
Sai Prasad
Ranch Hand

Joined: Feb 25, 2002
Posts: 560
Are you setting the java.rmi.server.codebase property value at the server startup?
I can start my server only if I mention the codebase property and I had to mention the drive letter like -Djava.rmi.server.codebase=file:/D:\scjd\starting/
How are you setting the value with out the drive letter?
Adam Roberts
Ranch Hand

Joined: Mar 18, 2002
Posts: 71
Works fine for me with out it
But I did put in the docs about starting with the codebase should the classpath not be set right
Something like
where <yourparentdirhere> = what the classpath should be
Mark Spritzler

Joined: Feb 05, 2001
Posts: 17276

My Documentation was a 500 page dissertation on the Way and the Life of a Java Developer, It has Poems, and Essays, and just plain BS.
Actually I really went all out in the Design.txt. It was about 5 pages and answered every question they had in the Specs, and a little bad Class Diagram UML design of my, well, design.
My Readme, had what you just mentioned, but also had a complete list of all the files, and all that files listed in each jar.


Perfect World Programming, LLC - iOS Apps
How to Ask Questions the Smart Way FAQ
Adam Roberts
Ranch Hand

Joined: Mar 18, 2002
Posts: 71
Ahh sarcasm :roll: :roll: :roll:
Looks like I might need to flesh out mine a bit
I agree. Here's the link:
subject: Documentation and other fun stuff
It's not a secret anymore!