【予定は未定】ふと思いついたVisualStudioアドインを使った機能
またしても需要なんてあるのか怪しい機能ですが
思いついたのでメモ代わりにここに書いておきます。
Koropokkur.NETの新機能として提供できたらと思ってはいますが
思いついただけなのでまだ何も作っていません!
んで何を作ろうとしているかと言いますと、それは・・・
「ヘッダコメント一覧表示機能」
なんかこの時点で興味をなくされて別のページに
移られてしまいそうな機能名ですが(^^;
どんなシロモノを想定しているかというと・・・
とあるフォルダがあるとします。
その中にはソースコードファイルや
S2Daoなんかで使うようなSQLファイルがあるとします。
- VisualStudioのエクスプローラー上からそのフォルダを右クリック
- 「概要コメント一覧表示」を選択。
- ヘッダコメントと思われる最初のコメントを抽出
- (複数行コメントがある場合はコメント以外の行が見つかるまで抽出)
- ウインドウを表示し、そこに抽出したコメントの一覧を表示
- 1行−1ファイル。コメントの最初の1行だけ概要として表示
- コメント全文はその行にマウスカーソルをあてたときにツールチップ表示
- (欲を言えば1)ウインドウ以外にファイルなど、出力先を指定できる
- (欲を言えば2)行をダブルクリックするとそのコメントが書かれているファイルを開く
- (欲を言えば3)簡単なコメント検索機能付
(他人様も含めて)作成したクラスやSQLが
何を目的として作られたのかを
一覧で簡単に見れたら何かと開発しやすくなるんじゃないか、と
思ったのです。
誰でも一度は考えていそうなネタですが(^^;
というか既に誰かが余裕で作っていそうですが(^^;
というかeclipseあたりはデフォルトでこんな機能がありそうですが(^^;
もちろんクラスが何をやっているのか、については
「ファイル名で全てを語る!」のが理想だとは思います。
しかし、なんせファイル名は基本的にアルファベットなことが多いはずなので
作った人の意図が伝わりきらない時があるのではないかと。
勿論、ファイルを開いてヘッダコメントを見ればそういう場合も
なんとかなるのでしょうが、確認するためにいちいちファイルを開くのも
面倒かな〜、と。
(秀丸やsakuraエディタのgrepを使えばある程度効率化はできそうですが)
上記機能は
「ヘッダコメントくらいはみんなプロジェクト規約とかも守って
きちんと書いている」
ことが前提で、それが崩れるとゴミ情報を吐き出すだけ、という
身も蓋もない欠点があるわけですが、
そこはもう・・・割り切ってしまえ!とw