vimでphp-docのコメントを挿入する

php vim

今まで手書きで



/**

 * Hogeするクラス

 *

 * @version $id$

 * @author fugafuga

 * @license BSD

 */
とか書いてたんですけど、もっと簡単に挿入できるプラグインがありましたのでご紹介。

プラグインのダウンロード



http://www.vim.org/scripts/script.php?script_id=1355

配置
ダウンロードしたファイルを下記に配置



~/.vim/plugin/php-doc.vim

.vimrcに追記
キーバインドは好きに決めてください



inoremap  :call PhpDocSingle()i

nnoremap  :call PhpDocSingle()

vnoremap  :call PhpDocRange()

デフォルト値の変更



vim ~/.vim/plugin/php-doc.vim
" Default values

let g:pdv_cfg_Type = "string"

let g:pdv_cfg_Package = ""

let g:pdv_cfg_Version = "$id$"

let g:pdv_cfg_Author = "fugafuga "

let g:pdv_cfg_Copyright = "Copyright (C) 2007 Hoge Corporation. All Rights Reserved."

let g:pdv_cfg_License = "PHP Version 5.0 {@link http://www.php.net/license/5_0.txt}"

PHPファイルを編集



vim ~/test.php
上記の、「class」のライン上や「function」のライン上でC-Dすると、PHPDoc用のコメントが挿入されます。
結果
 * @license PHP Version 5.0 {@link http://www.php.net/license/5_0.txt}

 */

class HogeClass

{

    /**

     * getHoge

     *

     * @param string $strTest

     * @param string $strTest2

     * @access public

     * @return void

     */

    function getHoge($strTest, $strTest2)

    {

        return $strTest;

    }
}

?>
こうなります。