Skip to content
On this page

FunctionCommentThrowTag

Verifies that a @throws tag exists for each exception type a function throws.

Scope

Squiz.Commenting.FunctionCommentThrowTag

Description

If a function throws any exceptions, they should be documented in a @throws tag.

Usage

xml
<rule ref="Squiz.Commenting.FunctionCommentThrowTag"></rule>

Examples

No Examples Available

Please edit this page through Github to add examples.

Released under the MIT License.