This week's giveaway is in the Groovy forum.
We're giving away four copies of Groovy Fundamentals video training course and have Ken Kousen on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Javadoc for the plural form of a class Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Groovy Fundamentals video training course this week in the Groovy forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Javadoc for the plural form of a class" Watch "Javadoc for the plural form of a class" New topic
Author

Javadoc for the plural form of a class

Ryan Small
Greenhorn

Joined: Jun 09, 2011
Posts: 3

Assuming that I have a class named Service, how would I write a reference to the plural form of it in the Javadoc?

1. It doesn't seem right to use {@code Services} since "Services" isn't a class.
2. It seems even more awkward to write {@code Service}s.

Roel De Nijs
Sheriff

Joined: Jul 19, 2004
Posts: 6851
    
  24

Certainly would not opt for 1, because the reason you gave. I would opt for your 2nd option. It would be maybe awkward to write, but the output would be "Services" (that's also how it's done in e.g. the SCJP K&B books).


SCJA, SCJP (1.4 | 5.0 | 6.0), SCJD
OCAJP 7
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Javadoc for the plural form of a class