FreeBASIC DevHeaderStyleGuide
目次→FreeBASIC のハッキング→FreeBASIC でのハッキングのための情報→C Header Style Guide←オリジナル・サイト
C ヘッダー・スタイル指南
このガイドの内容
このガイドは、C 指導書∞ でないし、ヘッダの変換方法の 段階的ガイド でもありません。
これは、維持したい理想的なヘッダを表すスタイル・ガイドです。
現在、私たちの管理下のヘッダの全てが、このガイドに 100% 一致するというわけではありません。
しかし、作業は、この標準を使うように進んでいます。そして、新しく作られるものは全て、この標準を使うべきです。
一般
- 変換は、オリジナルに非常に近い状態であるべきです。こうすると、変換は、よく知られているものに類似して、簡単に更新することができます。
- 可能な限り、識別子(あらゆる #defines を含む)を変えてはいけません。
- ヘッダーが、ずれも #included で、すべてが同じライブラリに属しているなら、より小さなファイルは、より大きい一つのヘッダに結合されるべきです。
- オリジナルのライセンスを、保持しなければなりません。
コーディング・スタイル
- ヘッダは、FreeBASIC の最新バージョンで使える必要があります。
- 識別子(FreeBASIC が大文字小文字を区分しないため)間の名前の衝突や、識別子と FreeBASIC キーワードの名前の衝突は、一方の識別子に下線を追加することで、解決されるべきです。
- 関数宣言や関数ポインタ型のために、外部(extern)の "c" ブロックを、cdecl 別名 "..." の代わりに使うべきです。
- プリプロセッサ指令(#definesを含む)は、保存しなければなりません。
例外:それが、異なる Cコンパイラのオプション (つまり extern の違い) を選択するためだけなら、削除してください。そして、もしそれが、サポートを更なるコードに提供しないなら、それを削除できます。
コンパイラーを選ぶ場合、GNU C をサポートするものを選択しなければなりません。
- FreeBASIC キーワードは、小文字でなければなりません。
FreeBASIC でサポートされない構成物を扱う
- インライン関数は、適切なら、マクロに変換すべきです。
- 構造宣言、関数体、または類似物の内側のプリプロセッサ指令は、FreeBASICでは、それらは捜し出されるので、外部に移動する必要があります。
- 宣言 (例えば関数宣言、あるいは配列初期化子) の間で、プリプロセッサー指令が、複数行にまたがって広げられた宣言は、手で書き直す必要があります。
ページ歴史:2016-03-12 13:37:46
日本語翻訳:WATANABE Makoto、原文著作者:SirMud