コメントを手っ取り早く書く
今日ソースを書いていて気づいた。
コメントはある程度、自動生成できるらしい。
手間が減って良いことだ。
■コメントの生成
Monodevelopを使用中、ソースコードに「///」と書くと、
付近のソースコードを解析して、コメントを自動生成してくれるらしい。
(しかも大文字で文章を区切って、間にtheとか付ける徹底ぶり）
そして見覚えのある記述方法。
もしかしたらXML Documentのコメントタグと互換かもしれない。
■XML Document
XML Documentは、詳しくはわからないがVisual Studioで業務用サービスを開発していたときに
何度もお世話になったコメント記述方法。
XML Documentが使えると何が便利かというと、
【Doxygen】を使えば下みたいなクラスリファレンスを簡単につくれる。
コード読めとは言っても、限度ってもんがあるので、
こういった形でドキュメント化できると、ありがたい。
Unityで自動出力される形式がDoxygenに対応しているかはわからないけど、
対応してたら過去資産の再利用が少し楽になるかも。
そのうち試してみよう。
Monodevelop君、今まで悪く言っててごめんよ。
（そういえば、最近はコードアシストが動かないって事もなくなったな）
