File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
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
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

Javadoc for the plural form of a class

Ryan Small

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

Joined: Jul 19, 2004
Posts: 5131

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
Don't get me started about those stupid light bulbs.
subject: Javadoc for the plural form of a class
Similar Threads
Get byte[] of image
Is Computer Data Officially Singular?
Service Provider Extension in jar - URGENT
WA #2 ..... word association
Write good comments and produce good javadoc