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

B&S: Pattern description in javadoc class docmuentation?

 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,

do you think to include a javadoc description in each class about the role this class play in a pattern is a good idea?

Or would you put such description in choices.txt?

Regards,
Darya
 
Reza Rahman
author
Ranch Hand
Posts: 580
5
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I did both. I mentioned the pattern name a class implements in the Javadoc and a more detailed description (explaining why itn was applied) in choices.txt.
 
Darya Akbari
Ranch Hand
Posts: 1855
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Sounds like a compromise with more emphasis on pattern and design decisions in choices.text

Regards,
Darya
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic