Hướng dẫn what are phpdoc comments?

1. Press Ctrl+Alt+S to open the IDE settings and select .

2. In the Enter section, select or clear Insert documentation comment stub checkbox.

Generate a PHPDoc block for a code construct

1. To invoke generation of a PHPDoc block, do one of the following:

   • Place the caret before the required code construct (class, method, function, and so on), type the opening block comment /**, and press Enter.

   • In the editor context menu, select and choose the code construct to generate PHPDoc comments for.

   • Press Alt+Insert, then select Generate PHPDoc blocks, and choose the code construct to generate PHPDoc comments for.

   

   PhpStorm analyzes the appointed code construct, extracts the data for parameters, return values, variables, or fields where possible, and on this basis generates a stub of a documentation block.

2. Describe the listed parameters and return values where necessary. PhpStorm checks and treats syntax in comments according to the code inspection settings.

PhpStorm analyzes the appointed code construct, extracts the data for parameters, return values, variables, or fields where possible, and on this basis generates a stub of a documentation block. If necessary, you can fill in the missing information.

1. In a PHPDoc block, select the desired empty line and press Ctrl+Space.

2. Select the relevant tag from the suggestion list.

3. If the entered tag has several values, press Ctrl+Space and select the desired value from the suggestion list.

You can configure the appearance of PHPDoc comments, the presentation of class names, and the default tags sorting order. 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.

1. In the Settings/Preferences dialog (Ctrl+Alt+S), go to .

2. Switch to the PHPDoc tab an configure the desired appearance options by selecting or clearing the checkboxes.

3. Specify how you want PhpStorm to present class names for properties, function parameters, return and throws values, and so on, by selecting or clearing the Use fully-qualified class names checkbox.

4. If necessary, define how the generated PHPDoc tags should be sorted by selecting the Sort PHPDoc tags checkbox.

   • Use and to add or remove the PHPDoc tag entries from the list.

   • Use and to arrange the PHPDoc tag entries order.

Using PHPDoc code inspections

PhpStorm 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.