開発指針

• コーディングスタイル
  インデントは4 tab / 4 shiftとする。その他のスタイルは既存のソースコードに準ずる。 なお、エンコーディングは UTF-8 を使用することとする。

• 外部設計
  外部設計結果はJavadoc形式でソースコード内に直接記述する。package.htmlも活用する。 図などHTMLでは記述しにくいものについては、Office系ツールで記述し、doc配下に入れ、 ソースコードにはその参照先を記述する。
  なお、ここで言う外部設計とは、例えばUDPReaderが受け付けるメッセージ形式や 外部アプリケーションから呼び出されるサービスの外部仕様などを指す。

• 内部設計/詳細設計
  内部設計/詳細設計は「ソースコードがすべて」を原則とするが、アルゴリズムが複雑な場合など、 適時コメントで補足する事。

• メモ類
  たとえば、開発環境のセットアップの方法など、外部の利用者も含め、みんなで共有すべきメモ類は、 Wikiを活用して、どんどん記述することに心がける。

• プロジェクト運営指針 / 開発指針
  指針に類するものが、さまざまな文書に分散されると、プロジェクト運営上、良くない。 指針類は、Wikiを活用し、ひとまとめに記述することとする。