aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes B&S: Pattern description in javadoc class docmuentation? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "B&S: Pattern description in javadoc class docmuentation?" Watch "B&S: Pattern description in javadoc class docmuentation?" New topic
Author

B&S: Pattern description in javadoc class docmuentation?

Darya Akbari
Ranch Hand

Joined: Aug 21, 2004
Posts: 1855
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


SCJP, SCJD, SCWCD, SCBCD
Reza Rahman
author
Ranch Hand

Joined: Feb 01, 2005
Posts: 580
    
    5
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.


Independent Consultant — Author, EJB 3 in Action — Expert Group Member, Java EE 6 and EJB 3.1
Darya Akbari
Ranch Hand

Joined: Aug 21, 2004
Posts: 1855
Sounds like a compromise with more emphasis on pattern and design decisions in choices.text

Regards,
Darya
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: B&S: Pattern description in javadoc class docmuentation?