次に、ライブラリ本体とは少し離れて、プログラムの更新履歴を記載するChangeLogファイルに触れておきます。更新履歴ファイルがあると、ライブラリ利用者にも更新状況が分かりやすいですし、作者自身にとっても後でデバッグやソースコードの見直しの際の助けになるでしょう。
更新履歴ファイルは、単なるテキストファイルです。厳密なフォーマット定義はなく、GNU Coding Standards（注8）に従った記述をしているプログラムも多いですが、実際には作者の自由です（リスト8〜10）。
リスト8：script.aculo.us 1.7.0のCHANGELOG例
*V1.7.0 beta 2* (December 18, 2006)
* Change the default setting for effects to support up to 60fps,
if renderable by the browser. Add performance info to effects unit test.
* Change get/setOpacity to use Prototype's new support for cross-browser opacity.
リスト9：gcc 4.1.1のChangeLog例
2006-04-04 Alex Deiter <tiamat@komi.mts.ru>
PR bootstrap/27023
* Makefile.tpl (multilib.out): Remove trailing backslash.
* Makefile.in: Regenerate.
リスト9：gcc 4.1.1のChangeLog例
2006-04-04 Alex Deiter <tiamat@komi.mts.ru>
PR bootstrap/27023
* Makefile.tpl (multilib.out): Remove trailing backslash.
* Makefile.in: Regenerate.
リスト10：Linuxカーネル2.6.19のChangeLog例
commit 0215ffb08ce99e2bb59eca114a99499a4d06e704
Author: Linus Torvalds <torvalds@woody.osdl.org>
Date: Wed Nov 29 13:57:37 2006 -0800
Linux 2.6.19
It's all good.
このように、ロジェクトによって更新履歴の記述フォーマットが違うだけでなく、ファイル名すら統一されていません。Perlでは標準モジュールの添付ドキュメントでもChangesとChangeLogといったファイル名が混在しています（注9）。お好きなファイル名を利用してよいようです。
※注9：
Perl本体（バージョン5.8.8）の配布アーカイブに含まれるファイルでは、Changesが38ファイル、ChangeLogが10ファイル、大文字のCHANGESが2ファイルとなっていました。
世界のプログラマの共通言語は英語ですから、更新履歴も、できれば日本語でなくてカンタンな単語だけでかまわないので英語で書いておきたいところです。主語・述語など文法は気にせず、「add」や「remove」、「fix」といった動詞と関数名・オプション名だけでも記載してあれば、プログラマは意図する変更箇所を推測してくれるでしょう。
|
