複数人で開発するときに揃えたほうがいいところ: どのクラス/コンストラクタ/オブジェクトのメソッドを実行しているのかを明示する

気づいたところをメモしていくところ。今さら…とか恥ずかしがらずに書く。

どのクラス/コンストラクタ/オブジェクトのメソッドを実行しているのかを明示する

例えばSuperPagesと、これを継承するBasicPagesという二つのコレクションがあり、これらはどちらも使うものとする。

SuperPagesがgetというメソッドを持っていた場合、BasicPagesももちろんgetメソッドを持っているが、どこかのクラスだかコンストラクタで、

initializeMethod: function() {
  this.collection = new SuperPages();
},
getPages: function() {
  return this.collection.get();
}

こういう風に書いてしまうと、後々見たときに、

getPages: function() {
  return this.collection.get();
}

ここだけを見て、どのコレクションに対するgetなのか分からず、検索が出来ない。。

というわけなので、明示しておく。

initializeMethod: function() {
  this.superPages = new SuperPages();
},
getPages: function() {
  return this.superPages.get();
}

明示というか、こういうクラスやコンストラクタをどこかで使うときは別の名称（collectionのような）を使用せずに、識別子として名前をそのまま使ったほうが、後で見る人がうれしい。

フレームワークを使うと、同じメソッド名が量産されるので、より意識したほうがよい。