Monday, April 15, 2013

Order of Tags in Java comments




Order of Tags
Include tags in the following order:
  • @author (classes and interfaces only, required)
  • @version (classes and interfaces only, required.)
  • @param (methods and constructors only)
  • @return (methods only)
  • @exception (@throws is a synonym added in Javadoc 1.2)
  • @see
  • @since
  • @serial (or @serialField or @serialData)
  • @deprecated 

No comments:

Post a Comment