この記事の目的
コードレビューや設計審査をしてもらった際にメモにまとめているが、メモだと見づらい
そこで!
せっかくなので記事にまとめることで
わかりやすく見直しやすいメモを作ろう
筆者のプロフィール
- 社会人三年目 大手メーカーシステム開発
といいながらも2年間ほぼ研修で業務経験は1年程度 - 想定する読者
- コード書く際に何を意識したらよいか分からない人
- 後輩に教えているけど、何が分からないか分からない人
設計
- MVC
- 一般的にModel(データ)、View(UI)、Cntrol(制御)は分けた方が良い
- 責務を明確にする
- 名前をしっかり定義できると責務も明確化できてよい
- カプセル化を意識
- できたら作ったものは他に流用できた方がいい
- そうすると、部品を用意して他から使ってもらうように考えるとよい。
- 抽象化できてたら問題が起こった時の切り分けも楽になる
- 先を見越してコードを書く意識がないので、こういうことが起きたらどうする?今後も使うためにはどうしたら便利かな?などで誘導してもらえるとありがたい
- この責務は何かな?だとしたら名前は何かな?などある程度あたりを付けてもらえると考えやすい
コード
- 設計がしっかりしていればその通りコードを書くだけでいいはず。これが理想
- シンプルなコードにすべき
- 仲介役みたいなものはなるべく排除
- 順番管理はさせないように
- 意識しないでできるようにコンストラクタを活用するなど工夫する
- 順番があるものを外部のモジュールに頼らない方が良い
その他のメモ
- 責務といってもなかなかわかんなかったのでコメント駆動にするといいかもしれない
- まずやりたいこと1行程度でコメント書いて、それだけシンプルに起こす
機嫌よく過ごすためのメモ
- おやつがあると嬉しい
- ブラインド開けると開放感がすごい
違う会社かと思ったくらい気持ちよく過ごせる