Is there a way to insert PHPDoc in VIM using a command or key combination?
For example, I have a class:
class MyClass
{
public function __construct() { }
public function __destruct() { }
/* command here to insert PHP doc */
public function abc() { }
}
I would like to insert something like:
/**
* method()
*
* description
*
* @access
* @author
* @param type $varname description
* @return type description
* @copyright
* @version
*/
And then I can full out the rest manually. Thank you
Answer
This can be done pretty effectively with the lightweight phpDocumentor plugin.
Edit Here's a modified version with more recent development.
Edit Here's version 2 of the phpDocumentor plugin. It is more recent than the above two links.
Install the plugin into your $VIMFILES/plugin directory and add this to your .vimrc:
" PHP documenter script bound to Control-P
autocmd FileType php inoremap <C-p> <ESC>:call PhpDocSingle()<CR>i
autocmd FileType php nnoremap <C-p> :call PhpDocSingle()<CR>
autocmd FileType php vnoremap <C-p> :call PhpDocRange()<CR>
The above binds phpDocumentor to Ctrlp in insert, normal, and visual modes. Place your cursor on a class, function, or variable definition, press Ctrlp, and the plugin will attempt to form a doc block based on the definition.
Example function doc block:
/**
* testDocBlock
*
* @param mixed $param1
* @param mixed $param2
* @static
* @access public
* @return boolean
*/
public static function testDocBlock($param1, $param2) {
// Pressed Ctl-p while cursor was on the function definition line above...
}
Example class doc block
Copyright, version, author, etc are included by default in a class doc block. You can modify the plugin to include your own default values for these:
/**
* TestClass
*
* @package
* @version $id$
* @copyright
* @author Michael <[email protected]>
* @license
*/
class TestClass {
}
Full abstract class example:
<?php
/**
* TestClass
*
* @abstract
* @package
* @version $id$
* @copyright
* @author Michael <[email protected]>
* @license
*/
abstract class TestClass {
/**
* publicProp
*
* @var string
* @access public
*/
public $publicProp;
/**
* privateProp
*
* @var string
* @access private
*/
private $privateProp;
/**
* testDocBlock
*
* @param string $param1
* @param string $param2
* @static
* @access public
* @return boolean
*/
public static function testDocBlock($param1, $param2) {
// code here...
}
}
?>