---

Ⅰ. 插件描述

Syntax Highlight Plugin for vim

Ⅱ. 基本信息

创建日期：  2015-06-23 使用用户：  1 Github星：  2 插件作者：  Rubén Beltrán del Río

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'benbeltran/api-notation-vim'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'benbeltran/api-notation-vim'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'benbeltran/api-notation-vim'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/benbeltran/api-notation.vim

Ⅳ. 文档说明

# API Notation Syntax for Vim

This is a syntax for api notation, a simple notation I've been using for
annotating module APIs in specs and other documents.

Installing

Install with pathogen:

1. Clone the repo or copy the files to your .vim/bundle dir
2. Reload the vim
3. Enjoy the vim

API Notation Reference

The most recent reference as of now is in this gist, so
check that to be sure. But here's a reproduction of the notation.

NameOfClass.WithPossibleNamespace
   + class property
   - instance property
  ~> listened events (socket)
  +> listened events (class/module)
  -> listened events (instance)
  <~ dispatched events (socket)
  <+ dispatched events(class/module)
  <- dispatched events (instance)
  :: class method
   # instance method

Other symbols
  => returns
->() callback return
[xx] optional
<xx> data type

Recommended order: class first, then sockets, then instance. Internally:
Properties, events, methods.

// Anything after two forward slashes is a comment

How does it look like?

Like this.