• 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 Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

Documentations

 
Ranch Hand
Posts: 67
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I have the following questions about docuemtnations:


2) I am using Microsoft's wordpad for my documentation. Not using Notepad. Just want to double check that wordpad is ok to use.

3)I am generating javadoc for public access level modifiers only. The requirement does not say anything about it.

thank you.
 
Ranch Hand
Posts: 158
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
1) I have no idea. It's probably something that the text file processors that SUN uses understands.

2) You should be safe as long as the text files you generate with wordpad are viewable with notepad and any other simple textfile editor. Why don't you use the IDE for writing the choices file?

3) You should at least provide javadoc for protected and package access level methods. Everything that another programmer which uses your jar can see should be documented. Some people around here even provided javadoc for private methods. Maybe you should search around a little before asking.
 
Ranch Hand
Posts: 39
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Also, I did not put this in my choices.txt but I did document private members (especially private inner classes) on the basis that if they were refactored out and made visible, then the documentation would already be there. Plus, more documentation makes it easier for the hypothetical "junior programmer" to read.
 
reply
    Bookmark Topic Watch Topic
  • New Topic