プログラミングマガジン

プログラミングを中心にIT技術をできるだけわかりやすくまとめます。

  • ホーム
  • リファクタリング
  • 【リファクタリング】「命名規則」の考え方(定数など)
 
 
     
  • サーバー言語  
    • Python
    • Ruby
    • PHP
    • SQL
  •  
  • インフラ  
       
    • AWS
    •  
    • 基本
    • Git
  • Web
       
    • Web開発
    • JavaScript
    • Vue.js
    • React
  •  
  • 設計  
       
    • 実装設計
    • DB設計
  • 問い合わせ
  

【リファクタリング】「命名規則」の考え方(定数など)

12.12

  • miyabisan2
  • コメントを書く

この記事は2分で読めます

基本的な考え方一覧

  • 具体的な単語を選ぶ
  • 接尾辞や接頭辞を使って情報を追加する。
  • 名前の長さを考慮する。
  • 「変数の種類」で「名前のフォーマット」を変える。
  • メソッドの場合は「そのメソッド本来の目的」を名前にする。
  • メソッドには「動詞」を入れる。

具体的な単語を決める。

意味が広すぎる単語とその代替案

例えば、makeよりはcreateの方が意味は明確になります。

単語名 代替名
get 「get」自身はメンバの値を返す役割のみにする。「Fetch」(DBから取得)や「Download」(ネットから取得)
send deliver、dispatch、announce、distribute、route
find search、extract、locate、recover
start launch、create、begin、open
make create、set、build、generate、compose、add、new
filter(抽出する) select(選択する)、exclude(除外する)
Clip(切り抜く) remove(削除する)、truncate(切り詰める)

接尾辞や接頭辞を使って情報を追加する。

単位を追加する。

  • size → max_size
  • limit → max_kb

単位の例

用途 単語
限界値 max、min
範囲を指定 first、last
包含(ほうがん)、排他 begin、end(endは範囲に含まれない)

属性を追加する。

全ての変数名に属性を必ず付加するのではなくバグに繋がりそうな箇所はできるだけ追加すること。

  • html →html_sjis
  • url → url_enc

名前の長さについて

長さの判断

  • ローカル変数等のスコープが短い変数の場合は変数名は短くて良い(極端な話mとかgとかでも理解できるので良い)
  • 逆にグローバル変数とかスコープが大きい変数の場合は長い名前にすること

省略系は使って良いか?

BackSpaceNameとかなら「BSName」に省略してしまっても良いかの判断は一般的に認識されているかで行いましょう。例えば検索エンジン最適化の「SEO」とかなら一般的に広く認知されているので他人が読んだときでもすぐに理解できるでしょう。

書いても書かなくても意味が通じる単語は捨てる。

例えば、「ToString」とかは「ConvertToString」を短くした表現だと思われるが、「ToString」で十分意味が通じています。

「変数の種類」で「名前のフォーマット」を変える。

例えば、定数は「MAX_LENGTH」、変数は「value」等。

定数一覧

プログラミング名
長さ LENGTH
最小 MIN
最大 MAX
パス PATH
データベース DATABASE
ディレクトリ DIRECTORY
合計 TOTAL
添字 INDEX
完了 DONE
初期化 INITIALIZED

メソッドの場合は「そのメソッド本来の目的」を名前にする。

例えば、引数で数の配列を渡してその数を全て足算して戻り値として返すメソッドがあった場合に「getSum」(取得する)とするのではなく「computeSum」(計算する)とすることとした方が自然です。「取得」がメソッド本体の本来の目的でなはなく「計算」が本来の目的になる。

スポンサーリンク
  • 2019 12.12
  • miyabisan2
  • コメントを書く
  • リファクタリング
  • Tweets Twitter
  • このエントリーをはてなブックマークに追加
  • LINEで送る

関連記事

  1. 2018 03.24

    【Javaリファクタリング】その3:脱ぬるぽ!(Null(ヌル)オブジェクトの活用)

  2. 2018 03.25

    【Javaリファクタリング】綺麗なコメントの書き方

  3. 2018 03.22

    【Javaリファクタリング】定数化(基本編、列挙型)

  4. 2018 03.24

    【プログラミング】パッケージ、メソッド、クラス、変数名等の命名規則

  5. 2021 08.28

    【リファクタリング】「クラスのよくある命名」

  6. 2021 08.21

    【リファクタリング】共通処理の良い書き方(Common関数やデータクラスの問題点なども)

  • コメント ( 0 )
  • トラックバック ( 0 )
  1. この記事へのコメントはありません。

  1. この記事へのトラックバックはありません。

返信をキャンセルする。

【BootStrap】概要的な知識、基本的なクラス

【VSCode】Railsのデバッグ設定(Mac)

RETURN TOP

著者プロフィール

エンジニア歴10年で過去に業務系、Webデザイン、インフラ系なども経験あります。現在はWeb系でフロントエンド開発中心です。

詳細なプロフィールはこちら

スポンサーリンク

カテゴリー

  • Android
  • AngularJS
  • API
  • AWS
  • C++
  • CSS
  • cursor
  • C言語
  • DDD
  • DevOps
  • Django
  • Docker
  • Figma
  • Git
  • GitLab
  • GraphQL
  • gRPC
  • Hasura
  • Java
  • JavaScript
  • Kubernetes
  • Laravel
  • linux
  • MySQL
  • Next.js
  • nginx
  • Node.js
  • NoSQL
  • Nuxt.js
  • Oracle
  • PHP
  • Python
  • React
  • Redux
  • Rspec
  • Ruby
  • Ruby on Rails
  • Sass
  • Spring Framework
  • SQL
  • TypeScript
  • Unity
  • Vue.js
  • Webサービス開発
  • Webデザイン
  • Web技術
  • インフラ
  • オブジェクト指向
  • システム開発
  • セキュリティ
  • その他
  • データベース
  • デザインパターン
  • テスト
  • ネットワーク
  • プログラミング全般
  • マイクロサービス
  • マイクロソフト系技術
  • マルチメディア
  • リファクタリング
  • 副業
  • 未分類
  • 業務知識
  • 生成AI
  • 設計
  • 関数型言語
RETURN TOP

Copyright ©  プログラミングマガジン | プライバシーポリシー