Factor/コーディングスタイル

ソースファイル

Factor のソースファイルではタブは使用できません。代わりに 4 つのスペースを使ってください。

できるだけ 1 行が 64 文字以内に収まるようにしてください。ただし、ドキュメントは例外です。ドキュメントでは、1 行の長さは任意です。

ほとんどのワード定義は、1 行 64 文字として 3 行以内に収まるはずです。

短い定義は 1 行で記述できます。長い定義は数行に分けてください。

ワードの定義はできれば 3 行以内に収めてください。ただし、case と cond を使うワードまたはリテラルを使うワードは別です。ワードに適切に名前が付けられ、定義が短ければ、そうしたワードを使ったコードはほとんどそのままドキュメントとして読むことができます。

長いコメントを付けるよりも、わかりやすいワード名を付け、ワードの動作についてはヘルプシステムを活用してください。

コード

Factor のワードに名前を付けるときは、instead_of_underscores のようにアンダースコアを使ったり、CamelCase のようにキャメルケースにしたりせず、named-with-dashes のようにハイフンを使う必要があります。

コピーまたはペーストされたあらゆるコードは、新しいワードにまとめる (factor out) ことができる必要があります。

制御フローのパターンを抽象化するには、コンビネータを使ってください。

可能な場合にはライブラリのワードを使ってください。

汎用性の高いワードがファイルの最初の方に、固有度の高いワードはそれより下に来るようにしてください。

スタック上の個々のオブジェクトを操作する代わりに、なるべくコレクションを使ってください。

データスタックをデータ構造として使わないでください。

意味のあるワード名を使ってください。(foo) や foo* のような名前が付けられたワードの多用は避けてください。

(foo) という名前のワードは、ワード foo を実装するためにだけ存在するべきです。

IRC チャンネルに来てください。私たちがコードをレビューします。一緒にやると楽しいですよ。