• 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
  • Ron McLeod
  • Tim Cooke
Sheriffs:
  • Devaka Cooray
  • paul wheaton
  • Mark Herschberg
Saloon Keepers:
  • Tim Moores
  • Tim Holloway
  • Stephan van Hulst
  • Frits Walraven
  • Jj Roberts
Bartenders:
  • Carey Brown
  • salvin francis
  • Piet Souris

How much should I tie program specific info into my docs for SCJD?

 
Ranch Hand
Posts: 147
IntelliJ IDE Java Ubuntu
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
An example of what I am asking...

/**
* Locates a Contractor based on a user defined search query.
*/

Could also be....

/**
* Locates a record based on a user search query.
*/
 
Ranch Hand
Posts: 516
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator

Yucca Nel wrote:An example of what I am asking...

/**
* Locates a Contractor based on a user defined search query.
*/

Could also be....

/**
* Locates a record based on a user search query.
*/



You should say what it does...
A low level class named "DatabaseHelper" could be "locating records based on arguments provided".
An higher level class named "ContratorServices" could be "locating contractors based on user defined search query.

Hope this helps.
Alex
reply
    Bookmark Topic Watch Topic
  • New Topic