---

Ⅰ. 插件描述

vim 插件，生成适应 PHP_CodeSniffer 规范的注释

Ⅱ. 基本信息

创建日期：  2015-05-15 使用用户：  1 Github星：  1 插件作者：  Ji Gang

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'jixiaod/vim-code-sniffer'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'jixiaod/vim-code-sniffer'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'jixiaod/vim-code-sniffer'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/jixiaod/vim-code-sniffer

Ⅳ. 文档说明

# vim-code-sniffer
vim 插件，生成适应 PHP_CodeSniffer 规范的注释，修改自Doxygen。

安装

可以通过配置vundle来安装，在 .vimrc 添加

Plugin 'jixiaod/vim-code-sniffer'

:PluginInstall

配置

配置自己的注释信息，添加到.vimrc

"vim-code-sniffer {
let g:SnifferToolkit_brief_string       = "Description"
let g:SnifferToolkit_phpversion_string  = "PHP version 5"
let g:SnifferToolkit_category_string    = "PHP"
let g:SnifferToolkit_package_string     = "Mojimall"
let g:SnifferToolkit_version_string     = "Release: @package_version@"
let g:SnifferToolkit_author_string      = "Gang Ji <gang.ji@moji.com>"
let g:SnifferToolkit_copyright_string   = "2014-2016 Moji Fengyun Software Technology Development Co., Ltd."
let g:SnifferToolkit_license_string     = "license from Moji Fengyun Software Technology Development Co., Ltd."
let g:SnifferToolkit_link_string        = "http://www.moji.com"
"}

使用

:Sni ＃函数头 & 其他
:SniFl  # 文件头
:SniCls # 类头
:SniBlock # 代码块