Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
Guidelines - Which Exceptions to Document
Document the following exceptions with the @throws tag:
- All checked exceptions.
(These must be declared in the throws clause.)
- Those unchecked exceptions that the caller might reasonably want to catch.
(It is considered poor programming practice to include unchecked exceptions in the throws clause.)
Documenting these in the @throws tag is up to the judgment of the API designer, as described below.
Guidelines
Document the following exceptions with the @throws tag:
This chapter is covered by JavadocMethod, using its property validateThrows. Proposal:
| Documentation Comments Rule |
Checkstyle Checks Used |
Sample files |
| Guidelines - Which Exceptions to Document |
blue✅JavadocMethod |
|
Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
Guidelines - Which Exceptions to Document
Document the following exceptions with the
@throwstag:(These must be declared in the throws clause.)
(It is considered poor programming practice to include unchecked exceptions in the throws clause.)
Documenting these in the
@throwstag is up to the judgment of the API designer, as described below.Guidelines
This chapter is covered by JavadocMethod, using its property
validateThrows. Proposal: