2014年2月15日土曜日

分かりやすい関数、変数名の付け方まとめ

リーダブルコードという本を読んだので参考になる点をメモします。

ー分かりやすいとはどういう意味か?
 =>他の人がコードを読んだ時に最短で理解する事ができること。

ー関数、変数名の付け方
   ー基本は名前に必要十分な情報が含まれている事
 ーgetPage(url)という名前は良いか
  =>インターネットからのPage取得ならばFetchPageやDownloadPageの方が明確
 ーint Size()は良いか
  =>何の量かわからない、Height()かNumNodes()かなどより具体的に
 ーStop()はどうか
  =>取り消しできないような重い処理の場合はkill()にする。
 ー良い名前が無ければ
  =>シソーラスを使ってよい英語が無いか調べてみる。
 ーイテレータが複数あってi,j,kと付けていくと紛らわしくなる場合
  =>イテレータに配列名の頭文字をつけてやる,あるクラブに所属している一人のメンバーを取り出すような場合clubs[ci].member[mi]と付けてやると不具合が見つけやすい。
 ー単位の情報は明確化しておいた方がバグが生じにくい(start_msミリセカンド)など
 ーパスワードは暗号化したものと暗号化していないもので分けるべき、暗号化前がplaintext_password,暗号化後がencrypted_passwordなど。
 ープロジェクト固有の省略形はさける、String->str Document->docは良いが、BackEndManager->BEManagerとすると誰も理解できなくなる。
 ーfilter("year <= 2011")というコードは、2011年以下のものを選択するのか、あるいは除外するのかが分からない
  => 選択するならばselect,除外するならばexcludeのように誤解されない名前にする。

0 件のコメント:

コメントを投稿