コーディングを人に押し付けるためのコツ
- 初見でも分かりやすいコードで書く。
- ビューはビュー用のライブラリ群に、処理は処理用のライブラリ群に書く。
- ビューを処理用のライブラリに書かない。
- 配置場所が混ざると他人が数時間使っても理解できないコードになる。
- 少しだけ単純な改変をしたいときに、いくつものファイルと関数を追わなければならないような書き方はしない。
- (クリックが一増えるごとに閲覧数が半減するという話がある。一つの関数を追う作業はワンクリックでは済まない。)
- ただし、何度も出てくるような類似の処理は関数化しておく。(修正が一ヶ所で済む。類似の機能を構築するときに使い回せれば構築が容易になる)
- 分かりづらい部分、注意しないと分からない部分、構築して初めてわかったことについてはコメントを入れる。
- 関数ごとに、関数の目的、返り値の意味、引数の意味をそれぞれコメントする。
- 想定する影響範囲も入れておいた方が良いかもしれない。
- 関数についてのコメントは、フォーマットを統一して各関数の記述の頭におく。
- 見れば分かるような単純な関数ならコメント不要。
- また、実態と違う説明が載っているくらいなら、ない方がマシ。(ハマりの原因になる)
- コメントはコメントとしての機能だけでなく、関数をグループ分けするときに仕切りに使える。
- コメントを一行一行に入れすぎない。煩雑。
- 自分よりコーディング能力の高い人と組む。