Question

Can I use multiple @throws javadoc tags if my application throws the same exception for multiple reasons? For example:

@throws UserException if issue 1 happened
@throws UserException if issue 2 happened
@throws UserException if issue 3 happened

Is it prohibited by JavaDoc standard?

Was it helpful?

Solution

It is valid in java 6,7 and 8. See the docs:

Multiple @throws tags can be used in a given doc comment for the same or different exceptions.

(emph. mine)

OTHER TIPS

Just tested this the generated JavaDoc contains all 3 @throws.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top