 |
 |
 |
Python ドキュメントの作成 |  |
 |
|
|
|
|
Python ドキュメントの作成 | |
|
|
Python ドキュメントは、可能な限り Apple Publications Style Guide に準拠することになっています。内容の合理性と、オンラインで 容易に取得できることから、このスタイルガイドが選ばれました。
Apple のスタイルガイドがカバーしていないトピックについては、この ドキュメントで必要に応じて議論していきます。
ドキュメントをHTMLに変換する際に問題が発生するため、脚注の使用はあまりお 勧めしません。脚注を使うのは、何かの情報を表示するのにそれがもっとも適し ている場合に限るようにしましょう。脚注への参照を文の最後に追加する場合は、 句点の後に追加しなければなりません。 LaTeX での記法は次のようになりま す。
この文には脚注への参照があります。%
\footnote{これが脚注です。}
脚注は、文の途中でも適切な場所で使用することができます。
Python ドキュメントの中では、オペレーティングシステムやプログラミング 言語、標準機関、その他の名前を含む沢山の特殊な名前を使っています。 こうした名前の多くはかなり古い時期にLaTeX マクロに割り当てられ、 その便利さから長い間利用されつづけてきました。現在のマークアップでは、 こうしたエンティティのほとんどには特殊なマークアップを割り当てません。 その代わり、推奨される表記法を提供して、ドキュメント作者が Python ドキュメントにおける表現の一貫性を維持できるよう手助けしています。
その他の用語や単語についても特に説明しておく必要があるでしょう; ドキュメントの作者はこれらの規約に従い、ドキュメント全体を通して 一貫性を保証しなければなりません。
``central processing unit'' (中央処理装置) のことです。多くの スタイルガイドが、この語を最初に利用するときには略さずに書かねば ならないとしています (ですから、どうしてもこの語を使う必要があるなら、 必ずそうしてください!)。 Python ドキュメントでは、読者が最初にどこを 読むのか合理的に予測する方法がないので、略語の使用を避けねばなりません。 代わりに ``processor (プロセッサ)'' を使う方がよいでしょう。
ある一連の標準仕様につけられた名前です。常に大文字だけからなります。 この名前を表現するにはマクロ \POSIX を使用してください。
私たちの好きなプログラミング言語の名前は常に大文字で始めます。
ある文字セットと、それに対応する符号化方式の名前です。 常に大文字で始めます。
1970年代初頭に AT&T ベル研究所で開発されたオペレーティングシステムの名前 です。この名前を使うにはマクロの \UNIX を使用してください。
|
|
|
Python ドキュメントの作成 | |
|
|