### ナビゲーション

- 索引
- モジュール |
- 次へ |
- 前へ |
- Python v2.6.2 documentation »
- Python のドキュメントの作成 »

# 2. スタイルガイド

Python ドキュメントは、可能な限り Apple Publications Style Guide に 準拠することになっています。内容の合理性と、オンラインで容易に取得できることから、 このスタイルガイドが選ばれました。

Apple のスタイルガイドがカバーしていないトピックについては、この ドキュメントで必要に応じて議論していきます。

脚注は、何かの情報を提供するのにもっとも適した方法である場合は利用されますが、 普通はお勧めできません。 脚注への参照を文の最後に追加する場合は、句点の後に追加しなければなりません。 reST 記法は次のようになります

    この文には脚注への参照があります。 [#]_ ここは次の文になります。

脚注はファイルの終端か、ファイルが非常に大きい場合は節の終わりに集められます。 docutils は自動的に、脚注の参照への逆リンクを作成します。

脚注は、文の途中でも適切な場所で使用することができます。

Python ドキュメントの中では、オペレーティングシステムやプログラミング言語、 標準機関、その他の名前を含む沢山の特殊な名前を使っています。 それらの名前のほとんどには特別なマークアップを割り当てていませんが、推奨される 表記法をここで提供して、ドキュメント作者が Python ドキュメント内の表現の一貫性を 維持しやすくします。

その他の用語や単語についても特に説明しておく必要があるでしょう; ドキュメントの作者はこれらの規約に従い、ドキュメント全体を通して 一貫性を保証しなければなりません。

CPU
  “central processing unit” (中央処理装置) のことです。多くのスタイルガイドが、 この語を最初に利用するときには略さずに書かねばならないとしています (ですから、どうしてもこの語を使う必要があるなら、必ずそうしてください!)。 Python ドキュメントでは、読者が最初にどこを読むのか合理的に予測する方法がないので、 略語の使用を避けねばなりません。 代わりに “processor (プロセッサ)” を使う方がよいでしょう。

POSIX
  ある一連の標準仕様につけられた名前です。常に大文字だけからなります。

Python
  私たちの大好きなプログラミング言語の名前は、常に大文字で始めます。

Unicode
  ある文字セットと、それに対応する符号化方式の名前です。 常に大文字で始めます。

Unix
  1970年代初頭に AT&T ベル研究所で開発されたオペレーティングシステムの名前です。

### ナビゲーション

- 索引
- モジュール |
- 次へ |
- 前へ |
- Python v2.6.2 documentation »
- Python のドキュメントの作成 »