GTK-Docスタイルのコメントを挿入する
関数の宣言や定義に、GTK-Docスタイルのコメントを挿入します。注意
GTK-Docスタイルのコメントを挿入するコマンドは、ハイライトモードのモードが以下のモードの時のみ利用できます。- C
- C++
- C/C++/ObjC のヘッダー
コードスニペットプラグインを有効にしておく
このコマンドは「コードスニペット」プラグインと連携して動作するため、事前に「コードスニペット」プラグインを有効にしておいてください。1.関数の選択
コメントを挿入したい関数の定義に、カーソル(キャレット)をセットします。複数行で記述されている関数の場合、関数の最初の行にカーソル(キャレット)をセットします。
2.コマンドの入力
以下のコマンドを入力します。
doc.gtk
3.コメントの挿入
以下のようにGTK-Docスタイルでコメントが挿入されます。挿入されたコメントは、「コードスニペット」と同様の操作方法で操作することができます。
4.コメントの記述
関数の引数や戻り値の説明と関数の説明を入力します。以上で完了です。
Doxygenスタイルのコメントを挿入する
関数の宣言や定義に、Doxygenスタイルのコメントを挿入します。注意
Doxygenスタイルのコメントを挿入するコマンドは、ハイライトモードのモードが以下のモードの時のみ利用できます。- C
- C++
- C/C++/ObjC のヘッダー
コードスニペットプラグインを有効にしておく
このコマンドは「コードスニペット」プラグインと連携して動作するため、事前に「コードスニペット」プラグインを有効にしておいてください。1.関数の選択
コメントを挿入したい関数の定義に、カーソル(キャレット)をセットします。複数行で記述されている関数の場合、関数の最初の行にカーソル(キャレット)をセットします。
2.コマンドの入力
以下のコマンドを入力します。
doc.doxygen
3.コメントの挿入
以下のようにDoxygenスタイルでコメントが挿入されます。挿入されたコメントは、「コードスニペット」と同様の操作方法で操作することができます。
4.コメントの記述
関数の引数や戻り値の説明と関数の説明を入力します。以上で完了です。