LoginSignup
0
0

リーダブルコード 第2章 名前に情報を詰め込む まとめ

Last updated at Posted at 2023-10-14
  • メソッド名に「get」といった明確ではない単語の使用は避ける
    例)インターネットから取ってくる処理のメソッド名は、
    getよりも
    FetchPage()``DownloadPage()の方が明確

  • 命名に困ったらシソーラス(類語辞典)を用いて単語を探す

  • i,j,k,iter という名前は、イテレータ以外に使うと紛らわしくなるので注意

  • イテレータが複数あるときは、i,j,kなどの1文字よりも具体性がある名前を使う
    例)
    if(clubs[i].menbers[j] == users[k])
    から、
    if(clubs[club_i].menbers[menbers_i] == users[users_i])
    といった、「変数名+_i」といった名前にする
    あるいは
    if(clubs[ci].menbers[mi] == users[ui])
    のように、clubsの最初の文字であるc+iciという名前にするのもよい

  • 変数が時間やバイト数など、計測できるものであれば、変数名に単位を入れるとよい

  • 名前をつけるとき、プロジェクト固有の省略形を使ってはいけない
    例)

    1. evaluation → eval
    2. document → doc
    3. string → str
    4. BackEndManager → BEManager
      1~3は一般的に知られる省略形だが、4は初めて見た人からすると、「BEManager」とは何の略かが分からないと思われる
  • 名前の中にある不要な単語は削除する
    例)
    「ConvertToString」を「ToString」に変更しても「stringに変換する」と通じる

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0