2006.01.30

Webページのビルドコメントについて

C#.NETで開発をする時には、
コード中のドキュメントコメントを利用すると、
一連の .htm ページとしてドキュメントを生成することができます。

[利点]
・コメント作成の共通化
 誰が見ても理解でき、同じように作成できます。
・新たにドキュメントを作る必要がなくなります。

[タグの種類]
主に以下のタグがあります。
・ <summary> タグは、型または型のメンバの説明に使用します。
 型の説明に補足情報を追加するには、
 <remarks > タグを使用します。
・ <exception> タグを使用すると、スローできる例外を指定できます。
 このタグは、メソッド定義に適用されます。
・ <returns> タグは、戻り値を説明します。
・ <param> タグは、メソッドのパラメータの1つを説明します。

これらを使用して、常に誰が見てもわかりやすいコメントを
書く事が大切になります。

コメントを投稿

(いままで、ここでコメントしたことがないときは、コメントを表示する前にこのブログのオーナーの承認が必要になることがあります。承認されるまではコメントは表示されません。そのときはしばらく待ってください。)

photo
matsui