プロジェクトを早く理解するためにどんなことに着目しているか

Question

###質問
誰かが完成させている、もしくは未完成のプロジェクトに追加機能などをつけようと思うとプロジェクトをある程度把握してないといけません。

私はUnityを使っているのですが、スクリプトが多くなるにつれてオブジェクト間などの関係性が複雑になり理解にとても時間がかかります。自分が作っているものならまだしも人が作っているものは余計わかりません。

Unityに限ったことではないですが、そういった時プロジェクトを早く理解するため何かできること。もしくは着眼する箇所がありますか？

作成者のコメントの書き方にもよるのでしょうか。

Answer 1

古いスライドですが今でも有用かと思います。基礎部分ではありますが。
「How to inspect complete scenes with Unity?」

自分ならまずはScene一覧を見る＋動かしてシーン遷移を把握。
次にヒエラルキー（GameObject）を見て、どのオブジェクトが何なのかを把握します。
スクリプトの動作を追う際は、MonoDevelopの「Go to Declaration（定義部へジャンプ）」や「Find References（他の使用箇所を検索）」、「Find in Files（全ファイルから文字列検索）」などをよく使います。
あとは必要に応じてPluginsフォルダ（外部ファイルやライブラリの有無）とEditorフォルダ（エディタ拡張の有無）を確認ですかね。

スクリプトの理解については、
「スクリプトが綺麗に書けているか・いないか」が大きく影響します。

変数やメソッドに分かりやすい名前が付いていればコメントは要りませんし、
きちんとコンポーネント指向に則ったカプセル化等が出来ていれば理解も早いのですが、
そうでないぐちゃぐちゃのコードは当然理解に時間が掛かります。
これはもう「そういうものだ」と思うしかないのかなと……（ここは他の方の意見も聞きたいです）

Comments

[JectABC]

具体的にどこに着目しているか教えていただきありがとうございます。
名前付けにもセンスが必要ということですね（汗）

[sakura_hana]

名前付けはセンスではなく知識とルールが必要です。
「コーディング規約」とか「デザインパターン」で検索するといいかと思います。

[JectABC]

形式的にもきちんと決まっているのですね
ありがとうございます。

Answer 2

誰も書かないので・・・　汗

これは非常に難しい問題ですが、基本は「他人のプログラムは分かんない」です（元も子もない

自社かどうかにもよりますし。
それでもやるとなれば自社のプロジェクトであれば前任が途中で放棄したとしてもある程度は資料も残ってるでしょう。
担当者もコメントを書いてるでしょうし・・・・

UNITYだと違いますので参考にならないと思いますが、C#やPHP、HTML等なら

• 何の為のプロジェクトだったのか？（目的）
• そもそも言語は何か？（これは簡単）　（手段）
• フレームワークやプラグインは何を使っているのか？（手段）

最低限大事なのはこの3つですかね？もっとあると思いますがとりあえず。

先にも書きましたが正直早く理解する方法なんて無いと思います。

企業であればそのために（担当が変わることも多いので）コーディングの規則があったり、勝手にフレームワークを導入しないようにしてると思います。
クラス・メソッドまで決めて作り始めているでしょうからそこの理解だけでしょうかね？

ここは余談ですが私はフリーランスなので企業等から相談があったときは中身も見ずに1からやり直しを提案します（汗

Comments

[JectABC]

貴重な意見ありがとうございます。
私はまだ学生で周りの人との規則は何も決めていませんでした。そういった面で企業側ではきちんと決められているところが多いと思うので今より少しは理解しやすいのかなと安心しました。
ありがとうございます