Switch to the PHPDoc tab an configure the desired appearance options by selecting or clearing the checkboxes. In the Settings dialog ( Ctrl+Alt+S), go to Editor | Code Style | PHP. Note that the tag for properties is no longer configurable, the default tag is inserted automatically. You can configure the appearance of PHPDoc comments, the presentation of class names, and the default tags sorting order. If the entered tag has several values, press Ctrl+Space and select the desired value from the suggestion list.Ĭonfigure formatting inside PHPDoc comments Select the relevant tag from the suggestion list. In a PHPDoc block, select the desired empty line and press Ctrl+Space. If necessary, you can fill in the missing information. 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. 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.ĭescribe the listed parameters and return values where necessary. Press Alt+Insert, then select Generate PHPDoc blocks, and choose the code construct to generate PHPDoc comments for. In the editor context menu, select Generate | Generate PHPDoc blocks and choose the code construct to generate PHPDoc comments for. Place the caret before the required code construct (class, method, function, and so on), type the opening block comment /**, and press Enter. To invoke generation of a PHPDoc block, do one of the following: Generate a PHPDoc block for a code construct In the Enter section, select or clear Insert documentation comment stub checkbox. Press Ctrl+Alt+S to open the IDE settings and select Editor | General | Smart Keys. You can open them for review in the Documentation tool window by pressing Ctrl+Q. PHPDoc comments in your source code are available for Quick Documentation Lookup, which helps you get quick information for any documented symbol. In PHPDoc comments, PhpStorm supports formatting options in compliance with the ZEND, PEAR, and other coding standards. If a certain tag has multiple values, code completion provides a list of available values. If you need additional PHP-specific tags, PhpStorm provides code completion that suggests the tag names that are relevant in the current context. Depending on your choice, PhpStorm will create the required tags or add an empty documentation stub. PhpStorm creates stubs of PHPDoc blocks when you type the /** opening tag and press Enter, or press Alt+Insert and appoint the code construct (a class, a method, a function, and so on) to document. For documentation comments, PhpStorm provides completion that is enabled by default.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |