ホーム > Programing > Readable

Readable code

基本コンセプト

  1. コードは理解しやすくなければならない
  2. コードは他のほとが短時間で理解できるように書かなければいけない。
  3. 小さいコード ≠ 絶対にいいこと
  4. コードの時間 = 設計 x 実装 x テスト x 理解するまでの時間

名前

  1. 名前に情報を詰め込む
    • 明確な単語を選ぶ
    • 変数名に大切な情報をつける
    • 気取った言い回しより、明確で正確な方を選択する
    • 汎用的な名前を避ける
    • 使う状況を選ぶ
    • 抽象的な名前より、具体的な名前を使う
    • 接尾辞や接頭辞を駆使する
    • 名前の長さを決める
    • 名前のフォーマットを駆使する

例:

GetPage()

FetchPage()

DownloadPage()

SendDeliver / Dispatch / Annouce / Distribute / Route
FindSearch / Extract / Locate / Revocer
StartLaunch / Create / Begin / Open
MakeCreate Setup / Build / Generate / Compose / Add / New / Initialize

例:

retval

ret_http_response_message

 サンプル
このページを共有:
  • このページをはてなブックマークに追加 このページを含むはてなブックマーク
  • このページをlivedoor クリップに追加 このページを含むlivedoor クリップ
  • このページをYahoo!ブックマークに追加
  • このページを@niftyクリップに追加
  • このページをdel.icio.usに追加
  • このページをGoogleブックマークに追加

このページのURL:

TOP