2007.09.14

規格ものの開発 - 定義ファイルの綴りを合わせる

カテゴリ:ソフト開発日誌
SCSI デバイスを直接制御するソフトに必須なのが、規格を表現する定義ファイルだ。些細なことだけど、この定義ファイルに使う単語の綴りでちょっと悩む。

原則は規格書に使われている綴りをそのまま、定義ファイルに使う。たとえば、TEST_UNIT_READY=0 という感じだ。空白は下線に置き換える。

単純なルールだったら良いが、READ (10) は?と考えると READ10, READ_10 でどちらにしようか悩むことになる。さらに綴りが長い PREVENT_ALLOW_MEDIUM_REMOVAL の様な例だと、省略しようかどうかどうかと悩む。

GPL/LGPL ソース、 DDK に似てくると、何だか気持ち悪いというのもある。

経験からすると会社や組織の仕事だと、省略はしない方が良い。するとして、ルールを書くか、規格書の定義をコメントで併記することにしている。見知らぬ人が保守することを考えると、クグって見つかる綴りを書いておいた方が良いと考えている。何かに似てしまったら、まぁ、仕方がないと考える。

個人開発だと、あまりきつい原則論は抜きで自由に書く事にしている。

ん?コーディングルールと衝突するって?デバドラ職人の胃の痛みだな。





TWITTER

最終更新日  2007.09.15 02:43:07
コメント(0) | コメントを書く
[ソフト開発日誌] カテゴリの最新記事