Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
Required Tags
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.)
These principles expedite automated searches and automated processing. Frequently, too, the effort to avoid redundancy pays off in extra clarity.
Guidelines
This chapter is covered by JavadocMethod. Proposal:
| Documentation Comments Rule |
Checkstyle Checks Used |
Sample files |
| Required Tags |
✅JavadocMethod |
|
Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
Required Tags
An
@paramtag is "required" (by convention) for every parameter, even when the description is obvious. The@returntag 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.)These principles expedite automated searches and automated processing. Frequently, too, the effort to avoid redundancy pays off in extra clarity.
Guidelines
This chapter is covered by JavadocMethod. Proposal: