2005年05月17日

style(9) — FreeBSD kernel source file style guide

FreeBSDユーザであれば man 9 style とすると読むことができる。またman -t 9 style | lprとすればPostScriptで綺麗に整形したものが印刷される。A4で9ページと非常に短い。webではHypertext Man Pagesで参照できる。

kernelと銘打ってあるが、その内容は一般のソースコードを対象にしていてユーザコマンドのコマンドラインの処理やエラー処理に関する記述もある。 どのような事柄を指定しているかというと、大略以下の通り。

コメント
ソースファイル先頭のcopyright noticeは/*-で始める。その他の再整形されたくないコメントは/**で始める。
ファイルの先頭に何をどう並べるか。
copyrightのコメント、RCS ID、ヘッダファイル(sys/*.h、ネットワーク関係のヘッダ、他のシステムヘッダ、#include "..."の順)。
マクロ
副作用のあるものや定数は全て大文字で。#elseや#endifのコメントの付け方。
構造体の書き方。リストの実装は自分で再発明せずにqueue(3)(LIST_*やTAILQ_*といったマクロ)を使え。構造体をtypedefするときには_tをつけるな。
関数
static修飾の奨励。__Pマクロを使うな。ヘッダファイルで宣言せよ。関数の前に何をするかを説明するコメントをつけよ。main()にはそのプログラムが何をするかの説明をつけよ。
その他
コードを変更する場合は既に使われているスタイルを尊重すべきだが、新しいコードが半分以上になったら新しいスタイルに切り替えよ。
コマンドラインの解析にはgetoptを使え。エラー処理には標準のerr(3)やwarn(3)を使え。出力にはprintf(3)を使え(fputs(3), puts(3), putchar(3)の使用禁止)。usage 出力の形式の規定。
狭義のコードスタイル。括弧のつけかた、インデント、改行の仕方。
値のテスト。ポインタのテストはNULLと比較せよ。ブール値以外は(!演算子を使うのではなく)比較せよ。
この記事へのトラックバックURL
http://blog.seesaa.jp/tb/3687143
※言及リンクのないトラックバックは受信されません。

この記事へのトラックバック
この記事へのコメント
コメントを書く
お名前: [必須入力]

メールアドレス:

ホームページアドレス:

コメント: [必須入力]

認証コード: [必須入力]


※画像の中の文字を半角で入力してください。

広告


この広告は60日以上更新がないブログに表示がされております。

以下のいずれかの方法で非表示にすることが可能です。

・記事の投稿、編集をおこなう
・マイブログの【設定】 > 【広告設定】 より、「60日間更新が無い場合」 の 「広告を表示しない」にチェックを入れて保存する。


×

この広告は1年以上新しい記事の投稿がないブログに表示されております。