---

Ⅰ. 插件描述

Generates documentation structure for a matlab function.

Ⅱ. 基本信息

创建日期：  2003-06-13 使用用户：  1 Github星：  1 插件作者：  Vinay Middha

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin '/generatematlabfunctioncomment'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle '/generatematlabfunctioncomment'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug '/generatematlabfunctioncomment'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/vim-scripts/GenerateMatlabFunctionComment

Ⅳ. 文档说明

Generates a comment skeleton for a matlab function.

For example:
function xs = get_slantx(x, y, angle)
When the script (VERSION 0.3) is run on this line the output is like:
function xs = get_slantx(x, y, angle)
% get_slantx  
%
% Input:
% ^^^^^^
% . x
% . y
% . angle
%
% Output:
% ^^^^^^^
% . xs
%% AUTHOR  Author Name

This format is compatible with Matdoc. See version comments below to know more about Matdoc.

For previous versions the output looks similar to:
% get_slantx  
% function xs = get_slantx(x, y, angle)
% PARAM xs [OUT]
% PARAM x [IN]
% PARAM y [IN]
% PARAM angle [IN]
% AUTHOR  Author Name

This script is derived from MakeDoxygenComment by Leif Wickland.

After the installation you can run the script simply by hitting <ALT+c> when the cursor is on function line.