有没有办法使用命令或组合键在VIM中插入PHPDoc?
class MyClass { public function __construct() { } public function __destruct() { } /* command here to insert PHP doc */ public function abc() { } }
我想插入一些东西:
/** * method() * * description * * @access * @author * @param type $varname description * @return type description * @copyright * @version */
然后我可以手动充分休息。谢谢
轻巧的
phpDocumentor plugin可以非常有效地完成。
编辑Here’s a modified version与最近的发展。
编辑Here’s version 2 of the phpDocumentor plugin.比上述两个链接更新。
将插件安装到$ VIMFILES / plugin目录中,并将其添加到.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>
以上将PHPDocumentor绑定到插入,正常和可视模式下的Ctrl。将光标放在类,函数或变量定义上,按Ctrl键,插件将根据定义尝试形成一个文档块。
示例功能doc块:
/** * 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... }
示例类doc块
版本,版本,作者等默认包含在一个类doc块中。您可以修改插件以包括您自己的默认值:
/** * TestClass * * @package * @version $id$ * @copyright * @author Michael <me@exmaple.com> * @license */ class TestClass { }
全抽象类示例:
<?PHP /** * TestClass * * @abstract * @package * @version $id$ * @copyright * @author Michael <email@example.com> * @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... } } ?>
原文地址:https://www.jb51.cc/vim/387522.html
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。