スタイルガイド
当ドキュメントの編集の手引き
このドキュメントは説明を行うものです。やり方を、分かりやすく噛み砕いて説明してください。 わかりやすいコードの実例のみを書く場合は、Wikiが別サイトとして存在します。
このドキュメントは、Forgeを使ってModを作る方法を知りたい方のための物です。
Java開発のチュートリアルにはしないでください。そうなると、Javaのクラスの働き方やJavaの基礎的構造を知りたい方の為のサイトになってしまいます。
フォーマット
重要
インデント挿入は スペース2個 で行い、Tabキーでは行わないでください。
タイトルは普通のタイトルの形式で大文字化する必要があります(日本語の場合は意識する必要はありません)。例えば、
- Guide For Contributing to This Documentation
- Building and Testing Your Mod
といった風にです。
基本、重要でない語を除いてすべての単語を大文字化してください。
「#」や「##」の代わりに、イコールやハイフンを使った下線を使うようにして下さい。h3以下には「###」などを使用して大丈夫です。このファイルのソースにはイコールやハイフンでの下線の例が示されています。イコール下線はh1に当たる文に、ハイフンを用いた下線はh2に当たる文にそれぞれ用いられています。