[Kazehakase-devel] コーディングスタイル

Back to archive index

Takuro Ashie ashie****@homa*****
2003年 2月 2日 (日) 03:11:31 JST


足永です.

コーディングスタイルですが,細かい所はどうでもいいのですが,
一つだけどうしても気になる点があります.

KazehakaseやKazehakaseEmbed等はkazehakase-type.hで構造体が定義/宣言され
それを操作する関数群はkazehakase.hでプロトタイプ宣言されていますが
(SipStoneのスタイルをそのまま継承?)ソースの規模がある程度以上になると,
このスタイルではコードの見通しが悪くなりますし,保守も面倒になります.

一般的に見やすいとされるスタイルは

* 一つのCソースファイル(*.c)に対しては基本的に同名のヘッダファイル(*.h)
  を用意し(例外はありますが),Cソースファイル内で定義された関数のうち,
  外部に公開する関数はヘッダファイルに記述し,公開しない関数はstaticを
  付けて,必要ならばCソースファイルの先頭で宣言する

* ファイル名と関数群のプレフィックスを揃える

てな感じだと思います.特にKazehakaseやKazehakaseEmbedのように状態を保
持する構造体が存在する場合,自然とオブジェクト指向的な記述になりますか
ら,この辺りのスタイルの持つ意味は重要です.
(こういったスタイルが日本語で明文化されている文書としては,例えばMAlib
のドキュメント http://www.malib.net/api/ja/node2.html が綺麗にまとまっ
ています)

というわけで,そのように修正しちゃってよろしいでしょうか?


あと,Emacs使いとしては,ファイルの先頭に

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */

とか入ってると嬉しいのですが,これも併せてやっちゃってよろしいでしょう
か?



Kazehakase-devel メーリングリストの案内
Back to archive index