「設計の理論」の版間の差分
削除された内容 追加された内容
→「単位動作」という概念: 末尾に参考文献のセクションを追加。 |
|||
558 行
なので、コード解説書にエントリポイントがどのファイルなのかを書いてないと、いちいち読者がファイルを開いて読まないと、どのファイルが最初に呼び出されるのかを理解できません。
:'''※ 注意:''' 下記では読者の共通知識のためゲームソフトを例に説明しますが（製造業の話題だとIT系の人が理解できないので、ゲームソフトで喩えている）、しかし実際のゲーム業界でどうしてるかは知りません。下記の書き方は、IT企業や製造業組み込みソフトなどでのファイル内容説明の書類の書き方を、単純にゲームにそのまま当てはめただけの説明です。
ファイル分割されたファイルが幾つも（いくつも）ある場合、例えばゲームソフトだとして、ジャンルがRPGなら
577 ⟶ 579行目:
</pre>
などのように、それらのファイルが何を処理しているのかを第三者が分かるように書いてください。また、なるべく箇条書きで書くのが、読みやすくて便利でしょう。
当たり前に残すべきメモのように思えるかもしれませんが、しかしこういったメモが残されてない職場は多くあります。悪い見本です。とにかく、瑣末なことでリバース・エンジニアリングを後任者にさせないように書類を残す習慣をつけましょう。
| |||