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