開発ルール の履歴(No.3)

• 履歴一覧
• 差分 を表示
• 現在との差分 を表示
• ソース を表示
• 開発ルール へ行く。
  • 1 (2017-03-19 (日) 12:01:00)
  • 2 (2020-06-06 (土) 17:55:57)
  • 3 (2021-12-10 (金) 21:51:32)

---

Tag: ソフトウェア 開発ルール 品質

方針†

1. 手作業はミスの元凶。可能な限り自動化を推し進めること。

環境†

開発環境†

1. 使用しているOS、IDE、プラグイン、ライブラリのバージョン情報を記録しておくこと。
2. 参照したコード、ライブラリの入手元を記録しておくこと。

リポジトリ†

1. SubversionやMercurialリポジトリを用意すること。
2. Tracを用意すること。

ドキュメント†

APIドキュメント†

1. Doxygen, Shpinxなどで自動的にドキュメントを作成すること。

UML†

1. UML図面はEnterpriseArchitectで作成すること。
   1. クラス図はEnterpriseArchitectでリバース作成すると手っ取り早い。
2. PlantUMLを使って作成処理を簡略化すること。

ソースコード†

事前・事後検証†

1. Assertによりメソッドや関数呼び出し時の事前・事後検証を確認すること。
2. tmpフォルダや生成物の出力フォルダは、実行前に削除する。（処理が失敗した場合に、以前の成果物と混同しないようにする為）

コメント†

1. 処理内容を簡潔にコメントとして記載すること。

ログ†

1. 処理状況をログファイルへ出力すること。
2. 出力したログファイルは適宜削除すること。（無限に増えてしまう状態の防止）
3. バージョン、ビルド番号等のアプリケーション情報を出力すること。
4. 標準出力と標準エラー出力が混在する場合があるので注意すること。（大抵の場合、標準エラー出力の方が先に出る）

例外†

1. 例外を無視せず、呼び出し側に必ず通知すること。

ビルド†

1. コンパイル時にエラー、警告が一切出ないこと。
2. スクリプトを用意して必要なパッケージ作成の自動化を行うこと。

ユニットテスト†

1. 可能な限りユニットテストコードを作成して自動的な検証を行うこと。
2. カバレッジレポートを生成してテストされていない箇所を確認すること。