Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc for the plural form of a class

 
Ryan Small
Greenhorn
Posts: 3
Eclipse IDE Java Netbeans IDE
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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).
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic