Inspectopedia Help

Enforce PHPDoc comment

Reports the elements without a PHPDoc comment or with a PHPDoc comment only containing the @noinspection tag.

You can use Missing PHPDoc Comment inspection to report only non-fully typed elements.

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

PhpEnforceDocCommentInspection
Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | PHP | PHPDoc | Code style

Inspection options

Here you can find the description of settings available for the Enforce PHPDoc comment inspection, and the reference of their default values.

Ignore private members

Not selected

Constant

Not selected

Function

Default: Selected

Class

Default: Selected

Method

Default: Selected

Property

Not selected

Class constant

Not selected

Inspection Details

By default bundled with:

PhpStorm 2024.2, Qodana for PHP 2024.2,

Can be installed with plugin:

PHP, 242.22893

Last modified: 11 September 2024