Skip to main content

Marco Castellani's Library tagged howto →  View Popular

13 Jul 09

How to Write Doc Comments for the Javadoc Tool

  • A doc comment is written in HTML and must precede a class, field,
    constructor or method declaration. It is made up of two parts --
    a description followed by block tags. In this example, the block
    tags are @param, @return, and
    @see.
  • An @param tag is "required" (by convention) for every parameter,
    even when the description is
    obvious. The @return tag is required for every method that returns something
    other than void, even if it is redundant with the method description.
    (Whenever possible, find something non-redundant (ideally, more specific) to use
    for the tag comment.)
  • 1 more annotations...
1 - 20 of 99 Next › Last »
Showing 20▼ items per page

Selected Tags

Related Tags

Sponsored Links

Ads by Google

Diigo is about better ways to research, share and collaborate on information. Learn more »

Join Diigo