画竜点睛を衝く@mapyo

日々やった事をつらつらと書くブログです

phpDocumenterを入れる

あんまり、phpのコメントの形式について考えた事なかったけど、それなりに入れないとダメなのかなぁと思って入れてみた。

こちら

phpDocumenterを入れる - もふもふブログ

を参考にやってみた。

.vimrcに以下を追加

NeoBundle 'PDV--phpDocumentor-for-Vim'

後はいつものインストール

デフォルト値を調整

~/.vim/bundle/PDV--phpDocumentor-for-Vim/plugin/php-doc.vimのDefault valuesのところを修正

" Default costome values
let g:pdv_cfg_Type = ""
let g:pdv_cfg_Package = ""
let g:pdv_cfg_Version = ""
let g:pdv_cfg_Author = ""
let g:pdv_cfg_Copyright = ""
let g:pdv_cfg_License = ""

特に入れるものなかったので、空にしてみた。消したいんだけど、消し方わからず。。。 Default valuesの部分はコメントアウトしている。

キーバインドの変更

.vimrcに以下を追加

nnoremap <silent>,pd :call PhpDocSingle()<CR>

ノーマルモードの時だけでよかったので、こんな感じにしてみたー。

使ってみる

以下のプログラムの時に、

<?php
class Hoge
{
    private function foo($bar, $piyo, $fuga=array(), $hogra=null)
    {
        return $bar;
    }
}

class Hogeの行と、private function fooの行で実行すると、以下のようになる。

<?php
/**
 * Hoge
 *
 * @package
 * @version
 * @copyright
 * @author
 * @license
 */
class Hoge
{
    /**
     * foo
     *
     * @param $bar
     * @param $piyo
     * @param array $fuga
     * @param $hogra
     * @access private
     * @return void
     */
    private function foo($bar, $piyo, $fuga=array(), $hogra=null)
    {
        return $bar;
    }
}

所感

思い出したら使ってみよう。癖がつかないと、しばらくずっと使わない気がする。。。