開發和下載開源軟體

category（Tag） tree

• 根

この文書はコーディングルールの統一が目的です。

【バージョン管理の数字について】
10進数の数字三つをピリオドで結んだものを用いる。
左から順に優先度が高く、従って更新頻度は低くなる。
左からそれぞれ（大規模な改正、更新）、（機能、項目の追加）、（小規模な更新、バグフィックス）の時に数字を増やす。
上位の数字が増えた場合、それより下位の数字は0になる。

【関数の命名について】
なるべく簡単な英単語を用いて機能を明確に表す事を第一とする。
英単語の一文字目のみ大文字として可読性を高める。
代表的な接頭語は以下の通り。
・Set	ライブラリに値を設定する関数
・Get	ライブラリの設定値を取得する関数
・Load	画像や音声をファイルから読み込む関数
・Draw	描画関数
・Play	再生の開始
・Stop	再生の終了

【変数の命名について】
なるべくわかりやすい名前を用いる。
小文字のみ使用可。
ライブラリユーザーの変数との衝突を避けるために構造体に組み込むのが望ましい。

【プリプロセッサ定義の命名について】
大文字のみ使用可
適用するスコープが短い場合は必ず#undefを用いる事

【ソースコードの書式】
タブ一つあたり半角スペース4つ分の横幅とする。
中かっこ{}によるインデントはタブを用いる。
対応する中かっこ{}の始まりと終わりは同一鉛直線上に位置する。
型名と変数名、関数名の間は半角スペース一つとする。ただし、構造体内部では変数名の始まる位置が全て揃うようにタブで調整する。
かっこ()と変数名、関数名の間にはスペースを空けない。
変数名、関数名と演算子の間は半角スペース一つとする。

【型について】
int型とfloat型に主軸をおき、void型,long型,double型はユーザーインターフェースとしては原則として使わない。

【ユーザーインターフェースについて】
基本的にDXライブラリにある関数のみ実装する。
PCとPSPのHW差を埋めるために必要な関数は実装する。
戻り値のエラーコードは基本的に-1のみ。

【最適化について】
著しく可読性を落とすような最適化は、最適化前の状態をコメントアウトしておくか、コンパイル対象から外すか、SVNにバックアップをとる。
PSP固有のHWであろうと何であろうと、ユーザーにそのことを意識させなければ速度を優先する。関数仕様が変わってしまうような変更は基本的に認めない。

【この文書について】
次の加筆、修正はプロジェクト管理者の担当とする。