スポンサーサイト

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。
当サイトは基本をすっ飛ばしてます。基本文法等は、@ITをどうぞ
カテゴリー: スポンサー広告

ドキュメント化可能

C#コード内に書いたコメントをドキュメント化(ヘルプファイル)にするのに、.NET1.1の頃は、NDocを使っていた。
でも、このNDoc、.NET2.0以降のサポートがないまま、開発が止まったような感じ(誰かが引き継いでいる?)。
NDOC日本語版
NDoc Online
2005年で更新が止まっている・・・
じゃあ、代替できるアプリないかなと探したら、ありました。
SandCastle
英語版だけども。まあ、英語を読めさえすれば、大体使える。
ドキュメント化できると思ったら、コメント書くモチベーションが上がりやすい、と良いなぁ。

(追記)
これに関係する話で、開発メンバーには、必ず
クラスコメント、メソッドコメントはきっちり書こう
と言っている。
時間がないから後で書こう、なんて言って書いた試しがない。
「仕様書があるから良いや」とか「誰もみないし」とか、よく言うんだけども、半年後の自分が見ないとでも?と聞きたくなる。
メソッドに対するコメントが書けないはずはないんだけどなと。
役割多すぎるなら分けろと。
書けないというなら、じゃあ、そのメソッド何のためにあるんだと。
「コレをやる」「アレをどうする」だけでなく、なんでそうする必要があるんだってこともできるだけ書いておきたいところだ。

int i = 100;//100をセットする。

ではなく、

int i = 100; //○○は××な理由により、100から始まる。

のほうが良いかな。単に処理内容を書くコメントはむしろ邪魔なんだよな。
誰にでもわかるようにコメントを書くのは難しい。が、書かないのはもっと質が悪い。
スポンサーサイト
当サイトは基本をすっ飛ばしてます。基本文法等は、@ITをどうぞ
カテゴリー: C# | コメント: 0 | トラックバック: 0


この記事へのコメント

コメントの投稿

非公開コメント


サイドバー背後固定表示サンプル

当ブログに書かれたソースコードは流用自由です。

バグ、スペルミス等はありうる事です。

ご利用の際は自己責任でお願いしますm(_ _)m

上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。