[Date Prev][Date Next][Thread Prev][][Date Index][Thread Index]

ChangeLog entry for LUNA methods



メソッドに対する ChangeLog の項目はどのような書式で書くのが適当でしょ
うか? 通常の関数に対する ChangeLog の場合,

    2003-10-08  Katsumi Yamaoka  <yamaoka@jpl.org>

        * w3m.el (w3m-url-to-file-name): Enable it to interpret
        file://localhost/ urls.

と「* ファイル名 (関数名): 変更内容」という書式で変更を記録しています.
しかし,luna.el のメソッドの場合は,同名の関数が複数存在することになる
ので,この書式では変更個所を一意に特定できません.

従来は,

    2003-10-16  TSUCHIYA Masatoshi  <tsuchiya@namazu.org>

        * shimbun/sb-zdnet.el (shimbun-make-contents): Small fix.
 
のようにファイル名が書いてあれば,クラスを特定できることが殆んどだった
ので,問題は顕在化していませんでした.しかし,最近の変更の結果,ファイ
ル名だけではクラスを特定するのに不十分なことが増えたので,何らかの書式
を考え出す必要があります.

とりあえず,最近の私の変更については,

    2003-10-17  TSUCHIYA Masatoshi  <tsuchiya@namazu.org>

        * shimbun/shimbun.el (shimbun-entity-insert)
        [shimbun-text-entity]: Simplified.

というように,「* ファイル名 (メソッド名) [クラス名]: 変更内容」という
書式を導入して誤魔化してありますが,これは単なる思いつきなので,不十分
かも知れません.

というわけで,オブジェクト指向のプログラムについて ChangeLog を記述す
る場合は,どのような書式で書くのが適切なのか,ご存じの方は情報提供をお
願いします.また,実際の production 現場では,こう言う書式で書いている,
というような情報も歓迎します.

よろしくお願いします.

-- 
土屋 雅稔 ( TSUCHIYA Masatoshi )