プログラミングマガジン

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

  • ホーム
  • リファクタリング
  • 【リファクタリング】「命名規則」の考え方
 
 
     
  • サーバー言語  
    • Ruby
    • Rails
    • PHP
    • Laravel
  •  
  • データ設計  
    • NoSQL
    • SQL
    • RDB設計
    • Oracle
  •  
  • インフラ  
       
    • AWS
    •  
    • 基本
    •  
    • セキュリティ
    • コンテナ全般
    • Linux
    • Git
  • Web
       
    • Web開発
    • JavaScript
    • Vue.js
    • React
    • TypeScript
  •  
  • 設計  
       
    • 実装設計
    •  
    • 認証設計
    • 例外設計
    •  
    • 動画設計
    • DDD
  • 問い合わせ
  

【リファクタリング】「命名規則」の考え方

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」等。

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

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

 

 

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

関連記事

  1. 2021 08.21

    【リファクタリング】共通処理の良い書き方

  2. 2018 03.25

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

  3. 2021 08.01

    【リファクタリング】業務の分析手法

  4. 2021 08.01

    【リファクタリング】「データクラス」について

  5. 2018 03.24

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

  6. 2018 03.24

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

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

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

返信をキャンセルする。

【BootStrap】雛形HTMLの作成

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

RETURN TOP

アーカイブ

  • 2023年3月
  • 2023年1月
  • 2022年11月
  • 2022年10月
  • 2022年9月
  • 2022年8月
  • 2022年7月
  • 2022年6月
  • 2022年5月
  • 2022年4月
  • 2022年3月
  • 2022年2月
  • 2022年1月
  • 2021年12月
  • 2021年11月
  • 2021年10月
  • 2021年9月
  • 2021年8月
  • 2021年7月
  • 2021年6月
  • 2021年5月
  • 2021年4月
  • 2021年3月
  • 2021年2月
  • 2021年1月
  • 2020年12月
  • 2020年11月
  • 2020年10月
  • 2020年9月
  • 2020年8月
  • 2020年7月
  • 2020年6月
  • 2020年5月
  • 2020年4月
  • 2020年3月
  • 2020年2月
  • 2020年1月
  • 2019年12月
  • 2019年11月
  • 2019年6月
  • 2019年5月
  • 2019年3月
  • 2019年1月
  • 2018年12月
  • 2018年7月
  • 2018年6月
  • 2018年5月
  • 2018年4月
  • 2018年3月

カテゴリー

  • .NET Framework
  • Ajax
  • Android
  • Apache
  • API
  • Auth0
  • AWS
  • Babel
  • Babylon.js
  • Bitbucket
  • BootStrap
  • C#
  • C++
  • CGI
  • CSS
  • Cypress
  • C言語
  • DBスペシャリスト
  • DDD
  • DevOps
  • Django
  • Docker
  • Eclipse
  • EKS
  • Firebase
  • Git
  • GitHub Actions
  • GitLab
  • GraphQL
  • gRPC
  • Hasura
  • Heroku
  • HTML
  • HTML5
  • Java
  • JavaScript
  • Javaサーブレット
  • Jekins
  • Jenkins
  • JIRA
  • jQuery
  • JSP
  • JSTL
  • JUnit
  • Kubernetes
  • Laravel
  • linux
  • Mac
  • Maven
  • MySQL
  • Next.js
  • nginx
  • Node.js
  • NoSQL
  • Nuxt.js
  • OAuth
  • Open ID Connect
  • Oracle
  • OS
  • PHP
  • PL/SQL
  • PostgreSQL
  • PowerShell
  • Prisma
  • PWA
  • Python
  • React
  • Recoil
  • Redis
  • Redux
  • Rspec
  • Ruby
  • Ruby on Rails
  • Salesforce
  • Sass
  • SEO
  • Slack
  • SPA
  • Spring Boot
  • Spring Framework
  • Spring MVC
  • SQL
  • Struts
  • Struts2
  • Sublime Text
  • Swagger
  • Tailwind CSS
  • Three.js
  • Tomcat
  • TypeScript
  • UML
  • Unity
  • UX
  • VB.NET
  • Visual Basic
  • VSCode
  • Vue.js
  • WebGL
  • WebHook
  • webpack
  • WebRTC
  • WebSocket
  • Webサービス開発
  • Webデザイン
  • Web技術
  • wireshark
  • XD
  • XML
  • インフラ
  • オブジェクト指向
  • クラウド
  • ゲームプランニング
  • ゲーム開発
  • サーバー
  • システム開発
  • スクラム
  • スマホアプリ開発
  • セキュリティ
  • その他
  • データベース
  • データ分析
  • デザインパターン
  • テスト
  • ネットワーク
  • バージョン管理システム
  • ハードウェア
  • プログラミング全般
  • マイクロサービス
  • マルチメディア
  • リファクタリング
  • 人間関係
  • 会計知識
  • 体調管理
  • 副業
  • 動画
  • 国際化
  • 応用情報
  • 情報処理技術者試験
  • 文字コード
  • 日常生活
  • 未分類
  • 業務知識
  • 要件定義
  • 設計
  • 関数型言語
RETURN TOP

Copyright ©  プログラミングマガジン | Wordpress Thema | @