| DoxyLabel.mac
-Doxygen仕様コメント挿入マクロ「もっと愛情を込メント」 Version 2.12 Copyright (c) ゆめよい-Project 2008-2013 |
■Doxygen仕様コメント挿入マクロとは
C言語ソースのコメントを自動的に挿入する秀丸マクロです。
関数、ファイル先頭、クラス、行末を自動的に判定し、ボタンを1つ押すだけで適切なコメントベースを挿入してくれます。
コメントの挿入、修正の手間を省き、記述ミスやソースのみ更新してコメントが古いまま等の問題を減らす事を目的としています。
JavaDoc、Qtスタイルに対応しています。
VisualStudioから利用するためのVBAマクロが用意されています(
VisualStudioからも同等の機能を利用する事ができます)。
サクラエディタから利用できるJScriptマクロが用意されています(同等の機能を利用する事ができますがアンドゥは効きません)。
以上の外部呼出しは秀丸の実行環境が必要 になります。
外部呼出し程度であれば、試用秀丸(送金前の状態)でも十分に使う事ができます。
もちろん送金をお勧めしますが試してみる程度であれば料金はかかりません。
■Doxygenとは
CやJavaなどのプログラム ソース中のコメントから，モジュール仕様書を書き出すツール。プログラムと文書を同時に管理できる。
http://www.doxygen.jp/
要するにDoxygenコメントは幅広く普及しているコメントの書き方です。
Doxygenを使用しなくてもこれにそって書かれたコメントはソースの上で管理するのにも役立ちます。
■どういう人に向いているマクロなの？
チュートリアル こちらでDoxyLabelで出来る事の全てを解説しています
■対応コメント
| 関数コメント | 関数行(非プロトタイプ宣言)で実行。コメント済みの関数で行うと更新コメントになる |
| ファイルコメント | ファイルの先頭行で実行。コメント済みの関数で行うと更新コメントになる |
| クラスコメント | クラス宣言の行で実行。クラス内のメンバ関数を自動更新 |
| 単行コメント | 単語の先頭で実行。プロトタイプ宣言に使うと同名の関数コメントの説明を自動コピー |
| 行末コメント | 行の末尾で実行。単語の途中で実行する事で更新記録を残します。上下にある近い行末コメントに合わせてタブが挿入されます |
| 複数行 コメント | 何もない所でマクロを実行 |
■Doxygen仕様コメント挿入マクロを使うには
秀丸の基本的な操作を理解していることが前提です。
・秀丸マクロの設定方法
・秀丸マクロの実行(ワンボタンに登録しておくと便利)
・秀丸のバージョンは V8.00以降 です。
■最後に
このマクロはあくまで効率を上げ、手間を省くための支援ツールです。
デフォルトのまま放置するような事があると結局同じ事が起こるので、きちんとコメント編集するようお願いします。
最初はただ日付と時間の入ったコメントベースを挿入するだけのマクロでしたが、それだけでも結構便利。
長いコンパイル時間を有用しようと少しずつ機能を改善していったらいつのまにかこうなっていた・・・。
元々は自分の書き方がベースなので、「こう書く方が一般的では？」な意見など多くあれば対応するかもしれません。
現在、機能も大きくなり、メンテナンス上の問題などから他のエディタへの移植などの予定はありません。
外部ツール呼び出しによる対応の範囲に留めようと考えております。
ご意見、ご質問は MAIL:yyp000@gmail.com まで
こんな機能あると便利、この書き方ではうまくコメントできなかった等なども受け付けております。
主に個人で使用していたものがベースなので書式そのものについての修正要望には対応できない場合がありますのでご了承下さい。
当マクロはフリーですが著作権そのものは放棄しておりませんのでよろしくお願い致します。
更新情報
2.12更新 2013/12/8
秀丸verアップに合わせてif構文を修正
当ソフトウェアは厳密なデバッグ、調査、動作確認をした上で配信しておりますが、
機種依存やドライバの不具合、常駐ソフト等により必ずしも完全に動作するとは限りません。
万が一動作しないような状況が発生することがあっても当Projectで責任を負う事が出来ない事をご了承ください。
基本的に技術的な質問等にはお答えする事はできません。付属のチュートリアル、サンプルをご覧ください。
夢見ホームページで解説記事を掲載する事もあります。
製作・著作 ゆめよい-Project