kokaさんの、ソースコメント展(そこてん)(ソースコメントの書き方・ノウハウを集めたい)
http://blogs.wankuma.com/koka/archive/2006/09/09/38191.aspx
に応えようとしたのですが、ognacのコメント記述ではテンプレートに当てはまらないので,ここにUPします。
特にコメントの書式は規定していないのですが, カスタム属性を利用しています。
---例▼
<AttributeUsage(AttributeTargets.All, allowmultiple:=True)> _
<Ext(Memo:="カスタム属性定義.class: コメント機能 + ORMapping用の項目定義を記述する")> _
<Ext(Memo:="Since 2005/12/05")> _
<Ext(Memo:="Othor ognac")> _
Public Class ExtAttribute
Inherits Attribute
'*
Private memo_ As String = Nothing
'*
<Ext(Memo:="注釈:複数保持")> _
<Ext(Memo:="入力値 云々")> _
Public Property Memo() As String
Get
Return memo_
End Get
Set(ByVal Value As String)
memo_ = Value
End Set
End Property
End class
---例▲
という風に, Ext(Memo:="") のみ規定し,複数指定OKとしています。
記述内容は,Freeにし, リフレクションでPickupするようにしています。
必要内容の過不足はProgramで判断できるので,書式Checkが可能です.
プログラムの実行じにコメントの内容を把握できるので,アプリケーションのルール基準設定にも利用でき,何かと重宝しています、
XMLコメントも便利機能ですが, NDOCでの管理になるので,二元管理の印象が強く、敬遠してしまいます。