Win a copy of 97 Things Every Java Programmer Should Know this week in the Java in General forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Paul Clapham
  • Jeanne Boyarsky
  • Junilu Lacar
  • Henry Wong
Sheriffs:
  • Ron McLeod
  • Devaka Cooray
  • Tim Cooke
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Frits Walraven
  • Tim Holloway
  • Carey Brown
Bartenders:
  • Piet Souris
  • salvin francis
  • fred rosenberger

Documentation and other fun stuff

 
Ranch Hand
Posts: 71
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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:
 
Ranch Hand
Posts: 560
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Adam,
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
Posts: 71
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Djava.rmi.server.codebase=file://c:/<yourparentdirhere>/
where <yourparentdirhere> = what the classpath should be
 
ranger
Posts: 17346
11
Mac IntelliJ IDE Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.

Mark
 
Adam Roberts
Ranch Hand
Posts: 71
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Ahh sarcasm :roll: :roll: :roll:
Looks like I might need to flesh out mine a bit
 
Do not threaten THIS beaver! Not even with this tiny ad:
Devious Experiments for a Truly Passive Greenhouse!
https://www.kickstarter.com/projects/paulwheaton/greenhouse-1
    Bookmark Topic Watch Topic
  • New Topic