bendoh / vim-php-tools

Handy tools for developing PHP in vim

php-tools

Handy tools for authoring PHP in vim

Defines the PhpFormatDoc command.

PhpFormatDoc will find the named function definition nearest to the cursor, and update / insert its associated docblock with proper types and alignments. This helps with annoying PHPDoc requirements and deals with re-aligning @param stacks as function arguments are modified.

Usage

• Execute :PhpFormatDoc while your cursor is within a function or a function DocBlock region.

• You might want to wire this to a handy key sequence: nnoremap <leader>pf <ESC>:PhpFormatDoc<CR>

• Any existing parameter descriptions will be preserved when the argument name matches. Parameter order and types are derived from the function signature. When a type is specified in the function signature, it will override any type specified in the @param line.

Questions, comments, suggestions, praise and flames should be sent to:

Benjamin Doherty [e-mail]