Win a copy of Re-engineering Legacy Software this week in the Refactoring forum
or Docker in Action in the Cloud/Virtualization forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

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

 
Yucca Nel
Ranch Hand
Posts: 147
IntelliJ IDE Java Ubuntu
  • Mark post as helpful
  • send pies
  • 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.
*/
 
Alex Belisle Turcot
Ranch Hand
Posts: 516
  • Mark post as helpful
  • send pies
  • 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
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic