Index: [Article Count Order] [Thread]

Date:  Mon, 13 Jul 2009 11:27:14 +0900
From:  "IWPS) 平本" <t.hiramoto@....jp>
Subject:  [coding-standard:00013] ドキュメントコメント
To:  コーディング規約の会 <coding-standard@....jp>
Message-Id:  <20090713110659.846C.59F887E@....jp>
X-Mail-Count: 00013

ひらぽんです。
先日はどうもありがとうございます。<(_ _)>

VB.NET の規約を見ていて思ったのですが
C# 同様、コメントにドキュメントコメントを含めるべきだと思いますが、いかがでしょうか?

--------------------------------------------
ドキュメントコメントの活用

''' <tag>コメント</tag> を多いに活用すること。
このコメントは、VS.NETやcscによって、
XML、HTML形式でのドキュメントに変換することができる。

public クラス、メソッド、プロパティには、必ず ''' コメントをつける。
--------------------------------------------

また ''' コメントは protected も可能な限り付けるべきというのが持論です。

ちなみにいまの現場では private も付けるように言ってます。

-- 
IWPS) 平本 <t.hiramoto@....jp>