saLibrary

趣味プログラムの記録

コメント装飾線

コメントの線の書き方を考えた所まで。

初めてプログラミングを勉強した時からコメントは線で囲い、ブロック形式にして明確に目立つようにしています。
なんででしょう、プログラム勉強した学校のサンプルコードがそうなっていたからでしょうか。

//--------------------------------------------------
// 関数
//--------------------------------------------------
void function() {
}

こんな感じ。

Doxygen形式の/** */はあまり好まないです。

/**
 * 関数
 */
void function() {
}

きっと線で区切られてないからでしょうね。
しかしなんとなく/** */の方がプロっぽいという印象を抱いています。
なんででしょう、自分と違うから、でしょうか。

Doxygenのマニュアルにはこんな自分の為に線で目立たせるような書き方も紹介されてます。

/********************************************//**
 *  関数
 ***********************************************/
void function(){}
/////////////////////////////////////////////////
/// 関数
/////////////////////////////////////////////////
void function() {}

でもあまりしっくりこない。
線は"----"か"===="じゃないと慣れないなぁと感じます。
"/////"という線で区切るのなら、まだ/** */の方がマシかなって。
感性の問題ですね。

まぁ、線のスタイルは置いといて、
長い事プログラミングしていると、この線の入力が地味に面倒と感じます。
ただのキー長押しなんですが、待ち時間がストレスになります。

最初は何かテキストファイルにでもコメント装飾線のテンプレートを書いておき、いちいちコピペする方法を思いつきました。
だがしかし、プログラミング中にいちいち別のテキストを開くという作業はかなりストレスです。
さらにキーボードから手を離してマウスまで使うとなるともう論外ですよね…。

次に思いついたのは、Windowsの辞書機能に登録しておく方法。
自分の場合"せん"と入力したときに候補として装飾線がでるようにしておきました。
f:id:sacky003:20170507151945p:plain:w300
当時はおおむね満足だったんですが、
コメントのラインばかり変換させていると、普通の"線"という単語が全然でなくなって困りました。
変換候補が怒涛のラインばかりでなんかうざいし、
f:id:sacky003:20170507152209p:plain:w300
"そうしょくせん"と入力すると"装飾+------------------------------------"となるし…。
で、イマイチと感じたのでこの方法はやめました。

次に思いついたのはVisualStudioの拡張機能を使って、コメント装飾線を入力するコマンドを作る方法。
以前にVisualStudio2013で作ったことがあるので、そのプロジェクトを引っ張り出してVisualStudio2017でビルドしなおしてみました。
f:id:sacky003:20170507150132p:plain:w300
メニューコマンドの追加方法とかいろいろ面倒だった思い出だけは残っていますが、どうすればよかったかが思い出せません。
まぁとりあえずマニフェストとか弄ってビルドします。
EnvDTEなどが参照エラーとなった再度追加しなおすとあっさり完了。
f:id:sacky003:20170507150647p:plain:w300

拡張機能のマニフェストに対応VisualStudioのバージョンをしっかり明記してあるので、
新しいバージョンが出たらいちいち再設定して再ビルドがいるのが面倒ですね。

という事でインストール。
f:id:sacky003:20170507150704p:plain:w300

無事にメニューコマンドに追加されました。
f:id:sacky003:20170507150911p:plain:w300
Ctrl+J の後、 1234かQWERで4種類の装飾線を入力されます。
1234はコメントブロックで、QWERはただのライン。
1234かQWERを打つとき、Ctrlを入力しているとちょっと線が長くなります。

コメントブロック
//****************************************************
//
//****************************************************
//+---------------------------------------------------
//
//+---------------------------------------------------
//====================================================
//
//====================================================
//----------------------------------------------------
//
//----------------------------------------------------

コメントブロック(長)
//************************************************************
//
//************************************************************
//+-----------------------------------------------------------
//
//+-----------------------------------------------------------
//============================================================
//
//============================================================
//------------------------------------------------------------
//
//------------------------------------------------------------

ライン
****************************************************
+---------------------------------------------------
====================================================
----------------------------------------------------

ライン(長)
************************************************************
+-----------------------------------------------------------
============================================================
------------------------------------------------------------

うーんこのニッチすぎる感じ、まさにオレオレライブラリ。
この方法はおおむね満足なんですが、
VisualStudioのバージョンが変わると拡張機能の方の再ビルドが必要な点と当然ですがVisualStudio以外で使えない点が気になりました。


結局、キーの長押しがストレスになるだけなのでそれを早くすればいいだけなのでは?
という事で、キーリピートを高速化しました。
f:id:sacky003:20170507141200p:plain:w300
これならVisualStudio以外でもそれとなく快適に線を打てますね。
もうこれでええやん。

今回はここまで。