Vimでコメントボックスを作成する方法

この記事にはVimでコメントボックスを作成する方法が書いてあります。

コメントボックスとは

コメントボックスというのは以下の画像のようなもののことです。関数の説明書きなどを複数行のコメントアウト（ここでは/* ～　*/)で囲んだもののことです。自分はコメントボックスと言っています。他にも呼び方があると思いますが、他の呼び方は知りません。

コメントボックスの作り方

下のコードのようになるよう作成していきます。

/*==================================* 
* 関数名: add                       *
* 機能  : 二つの引数を足し算する    *
* 戻り値:	a+b                 *
*==================================*/
int add(int a, int b)
{
    return a + b;
}

では、コメントボックスを作っていきましょう。まずはコメントボックスの中身を記述します。

関数名: add
機能  : 二つの引数を足し算する
戻り値:	a+b

int add(int a, int b)
{
    return a + b;
}

コメントボックスの左の縦線を作る

まず、コメントボックスの左の縦線を作ります。関数名の上にカーソルを移動させビジュアル矩形モードに入ります。

jキーなどでカーソルを「戻り値」の「戻」の下まで移動させます。

I(Shift+i:大文字のi)で挿入モードに入ります。挿入モードで *スペースと入力します。

escキーなどで挿入モードを抜けると以下のようになります。

上と下の辺を作成

次に上の辺を作成しましょう。下の画像の位置にカーソルを置きaキーで挿入に入って=などをタイプして適当な長さに線を引きます。

yyで今カーソルのある行をヤンクし、戻り値の行に貼り付けます。

下の辺の下に＊があるのでこの行を削除しておきます。

右の辺を作り完成

ビジュアル矩形モードで左の縦の＊を選択します。

y(ヤンク）し、行末へ移動してp(貼り付け）します。

コメントボックスの左上と右下に/を追加し、＝の長さを調整をして完成です。

この記事は以上です。