Ognacの雑感

木漏れ日々

目次

Blog 利用状況

書庫

ギャラリ

ognacのコメント記入法

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での管理になるので,二元管理の印象が強く、敬遠してしまいます。

 

投稿日時 : 2006年9月17日 2:28

Feedback

# re: ognacのコメント記入法 2006/09/17 11:43 じゃんぬ

利用する情報はちょっと違いますが、仲間ですね。

# s/othor/Author/g じゃないですか?

# re: ognacのコメント記入法 2006/09/17 12:42 ognac

は! はずかしい...かなりな量がそうなってる!!

# re: ognacのコメント記入法 2006/09/17 15:49 囚人

ほ~、こういう使い方するんですね。

でも、私にはそういう使い方は受け入れ難いです。

「誰が書いた」「いつ書いた」といった情報をソースコード、そしてアセンブリに残してもしょうがないと考えているからです。ソース管理できるなら尚更です。

クラスの説明等は XML コメントの方で十分だと私は思います。

開発に関わる人が凄い大人数になると考えが変わるかもしれませんが。

カスタム属性を定義する機会が滅多にないので参考になりました。

# re: ognacのコメント記入法 2006/09/17 16:22 ghost_shell

アセンブリにコメントを埋め込む方法として、
#if DEBUG
"Comments".ToString();
#endif
を考えたことがありましたが、そういう方法なら実際に使えますね。(簡単だし)

邪道な感じがかえっていろいろ試してみたくなります。

# re: ognacのコメント記入法 2006/09/17 22:57 ognac

囚人さん、ghost_shell さん、コメントありがとうございます。
メリット、デメリットともにある癖のある使い方ですが....

# re: ognacのコメント記入法 2006/09/18 23:51 koka

こんばんわ!

おぉ~こういった使い方もあるんですねぇ。
私でWikiに登録を試みてもよろしいですか?

んでやっぱり使うToolやプロジェクトの規模でコメントの書き方は変わってくるんですかねぇ。
そういった観点もWikiに反映してみます!

# re: ognacのコメント記入法 2006/09/19 1:04 ognac

koka さん、ありがとうございます。
> 私でWikiに登録を試みてもよろしいですか?
どうぞどうぞ,試してください。

>んでやっぱり使うToolやプロジェクトの規模でコメントの書き方は変わってくるんですかねぇ。
考えたことなかったです.自分に便利なようにしただけなので....

# re: ognacのコメント記入法 2006/09/19 10:10 ognac

ただ, 自分で version情報を埋め込んでいて、
version UP対応しているか否かを、自己checkできるようにはしいてます。

# re: ognacのコメント記入法 2006/10/05 13:30 NAL-6295

2年前は似たような事をしていましたが、その後自作のライブラリのバージョンから削除して、使わなくなりました。
やはりコメント的内容をアセンブリに入れたくないという観点からでした。
後は、変数名とか関数名とか日本語で書いていて、それ自体がコメントになるという事もあります。

# re: ognacのコメント記入法 2006/10/05 19:08 ognac

NAL-6295 さん、ありがとうございます。
舌先三寸 楽しませて頂いてます。
 変数/Method名を日本語にしてコメント兼用にするのは,
ognacと丁度反対ですね、数ヶ月前までは,そうしてました。
開発先の関係で,日本語名によるトラブルが続いたので,局所的使用派に転じました。

タイトル
名前
Url
コメント