On this page:
- Enabling documentation comments
- Generating a PHPDoc block for a method or a function
- Creating tags in a PHPDoc comment block
- Inspecting PHPDoc comments
- Configuring formatting inside PHPDoc comments
- Viewing PHPDoc comments
IntelliJ IDEA creates stubs of PHPDoc blocks
on typing the opening tag
/** and pressing Enter or pressing Alt+Insert and appointing the method.function to document.
If this feature is applied to a method or a function,
@var tags are created.
In any other places IntelliJ IDEA adds an empty documentation stub.
If you need additional PHP-specific tags, IntelliJ IDEA provides code completion that suggests tag names that are relevant in the current context. If a certain tag has multiple values, the same code completion provides a list of available values.
In PHPDoc comments, IntelliJ IDEA supports formatting options in compliance with ZEND, PEAR, and other standards.
PHPDoc comments in your source code are available for the Quick Documentation Lookup feature and open for review on pressing Ctrl+Q.
Enabling documentation comments
- Open Settings/Preferences dialog box, expand the node, then expand node, and click the Smart Keys page.
- In the Enter section, select or clear Insert documentation comment stub check box.
- For Python, scroll to the Insert type placeholders in the documentation comment stub option and select or clear the check box as required. Refer to the option description for details.
Generating a PHPDoc block for a method or a function
To invoke PHPDoc block generation, do one of the following:
Place the caret before the method or function declaration, type the opening block comment
/**, and press Enter.
- On the context menu anywhere in the editor, choose Generate, then choose Generate PHPDoc blocks, and choose the method or function to generate comments for.
- Press Alt+Insert, then choose Generate PHPDoc blocks, and choose the method or function to generate comments for.
IntelliJ IDEA analyzes the appointed method or function, where possible extracts the data for method parameters, return values, variables, etc., and on this basis generates a stub of a documentation block.
- Place the caret before the method or function declaration, type the opening block comment
- Describe the listed parameters and return values, where necessary. IntelliJ IDEA checks and treats syntax in comments according to the PHP Inspections settings.
Creating tags in a PHPDoc comment block
IntelliJ IDEA analyzes the appointed method or function, where possible extracts the data for method parameters, return values, variables, etc., and on this basis generates a stub of a documentation block. If necessary, you can fill in the missing information.
- In a PHPDoc block, select the desired empty line and press Ctrl+Space.
- Select the relevant tag from the suggestion list.
- If the entered tag has several values, press Ctrl+Space and select the desired value from the suggestion list.
Inspecting PHPDoc comments
IntelliJ IDEA provides a set of predefined code inspections targeted at PHPDoc blocks. These inspections check whether classes, methods, functions, variables, and constants are supplied with a PHPDoc comment and whether the tags in the comment match the documented item.
To enable or disable an inspection:
- Open the Settings / Preferences Dialog by pressing Ctrl+Alt+S or by choosing for Windows and Linux or for macOS, and click Inspections under Editor.
- On the Inspections page that opens, expand the PHPDoc node under the PHP node. The list of predefined inspections is displayed.
- To enable or disable an inspection, select or clear the check box next to it.
To have IntelliJ IDEA check that PHPDoc comments are provided for all code constructs of a certain type:
- Select the check box next to the Missing PHPDoc Comment inspection.
- In the Options area, select the check boxes next to the required code construct type: class, method, function, variable, or constant.
- To suppress reporting a Missing PHPDoc Comment error if a method or function does not contain any parameters and/or return values, select the Skip if empty.
Configuring formatting inside PHPDoc comments
You can configure the appearance of PHPDoc comments and the presentation of class names in the Settings dialog box, on the PHPDoc tab of the Code Style. PHP under the Code Style node. Note that the tag for properties is no longer configurable, the default @var tag is inserted automatically. See https://github.com/phpDocumentor/fig-standards/pull/55 for details.
- Open the Settings dialog box, click Code Style, then click PHP, and switch to the PHPDoc tab.
- Configure the alignment by selecting or clearing the check boxes in the tab.
- Specify how you want IntelliJ IDEA to present class names for properties, function parameters, return and throws values, etc. by selecting or clearing the Use fully-qualified class names check box.
Viewing PHPDoc comments
Quick Documentation Lookup helps you get quick information for any symbol that is supplied with Documentation comments in the applicable format. IntelliJ IDEA recognizes inline documentation created in accordance with the PHP Documentation format and shows it in the Documentation Tool Window.