FuelPHP Documentation 日本語版執筆基準

ファイル形式

文字コードは UTF-8 を使う。
改行コードは LF (Unix) を使う。
行数は原文と合わせる。これは、原文の追加/削除のマージ漏れがないことを行数で確認できるようにするためである。よって、文の途中で改行されている場合の改行位置まで厳密に合わせる必要はない。また、日本語版は GitHub へのリンクをフッタに追加しているので全体の行数は 1行多くなる。

日本語の句点は全角の「。」を、読点は全角の「、」を使う。
日本語には全角文字を使う。
英数字、符号には半角文字 (いわゆる 1 バイト文字) を使う。
数字は、慣習的に使われている場合を除いて、算用数字 (1、2、3) を使う。
半角文字と全角文字の間には、半角文字 1 字分のスペースを入れる。
丸括弧 ( ) の外側には、全角文字がきても半角文字がきても間に半角文字 1 文字分のスペースを入れる。
- 丸括弧 ( ) の内側には、全角文字がきても半角文字がきても間にスペースを入れない。
- 丸括弧 ( ) 内には句点は付けない。複数の文がある場合は、各文の間にだけ句点を付ける。
- 丸括弧が末尾にくる場合は、括弧の外に句点を付ける。