ホーム > 展示 > 良い設計良いコードとは
ソフトウェアアーキテクチャ博物館AtMuseum
良い設計良いコードとは


ソフトウェア疲労

ソフトウェア疲労［静的］

AIによる音声ガイドは こちら です。

一筆書きのコード例

４つのパターンで動くLED点滅コードです。（Source/Mode/BlinkApp.cpp）

- VisuialStudioでLEDBlink.slnで動きます

- このコードを起点とした設計実装エクササイズ[静的]で設計の基本を習得できます

ソフトウェア疲労［動的］

AIによる音声ガイドは こちら です。

良い設計良いコードの原則

部品化コード原則

AIによる音声ガイドは こちら です。

構造化コード原則

AIによる音声ガイドは こちら です。

大規模コード原則

AIによる音声ガイドは こちら です。

ソフトウェアの資産レベル

資産レベルを判定します

以下の１４の設問をチェックして下さい。 お手持ちのソフトウェア資産の価値を判定します。

ソースコードについて質問です

Q1:ファイルは1000行以内、関数は100行以内ですか？
大多数（9割以上）がその範囲内であれば”はい”

はい いいえ わからない

Q2:ファイルやデータは意味のある名称ですか？
名称から、何をしているのか推測できれば”はい”

はい いいえ わからない

Q3：データはファイル内スコープですか？
C言語の場合、データをstatic宣言していれば”はい”

はい いいえ わからない

Q4：フラグなどの暗黙のやりとりはないですか？
設計図の通りに情報を伝搬していれば”はい”

はい いいえ わからない

Q5：全体構造の規則がありますか？
階層化や入出力分離の規則が遵守されていれば”はい”

はい いいえ わからない

Q6：ファイルの依存関係は単方向ですか？
ファイル同士のinclude依存の上下関係が明確になっていれば”はい”

はい いいえ わからない

Q7：再利用の単位でフォルダ分けし管理していますか？
フォルダ内のファイル群に意味的まとまりがあり、フォルダ外部へ提供する
インターフェイスが明確ならば”はい”

はい いいえ わからない

設計ドキュメントについて質問です

Q1:ソースコード以外の設計情報はありますか？
設計ドキュメントが存在していれば”はい”

はい いいえ わからない

Q2：設計図はありますか？
自然言語のみではなく、UMLの図など何らかの図解があれば”はい”

はい いいえ わからない

Q3：ひとつのドキュメントになっていますか？
ドキュメントが章立てされて目次がある場合は”はい”

はい いいえ わからない

Q4:構造視点の設計図はありますか？
モジュール構造（関数やファイル）、あるいはタスク構造の構造図があれば”はい”

はい いいえ わからない

Q5:視点ごとに設計図を描いていますか？
静的構造の視点では構造図、振る舞いの視点では状態遷移図というように、
視点ごとに図面を分けて描かれていれば”はい”

はい いいえ わからない

Q6：ドキュメントと最新コードは同期していますか？
一括してバージョン管理し、変更プロセスが遵守されていれば”はい”

はい いいえ わからない

Q7：要求と設計図の追跡可能性はありますか？
仕様変更時、設計図で影響範囲が特定できれば”はい”

はい いいえ わからない