スポンサーリンク

メソッド名、迷った時に参考にできる単語一覧

プログラムコーディング時に変数名、プロパティ名で悩むことは多々あります。

指針、決めを、ルールを知れば迷いが減ります。

ここでは、なぜそのルールで命名するのか?と、

プログラム業界にて一般的に使われている単語を紹介します。

悩んだ時は参考にして命名すると悩みを減らすことができます。

基本的なルール

変数名、メソッド名を命名する時に気をつける基本を上げます。

  • 名前は開発環境が補完するので解りやすければ長くても良い。
  • Typo しないよう辞書で確認する。
  • 日本語は同じだが英語で複数の単語がある場合は違う単語と間違えないよう辞書で確認する。
  • 名詞、動詞、過去形、複数形に注意する。
  • ソースコードリーディングを習慣にして変数名、メソッド名を参考にする。
  • Apiリファレンスを参考に変数名、メソッド名を参考にする。
  • メジャーAPIのソースを読み、利用されている変数名、メソッド名を確認し参考にする。

クラス

  • 「名詞」。
  • パッケージの機能により同じ名前を付けられるが、開発時に自動インポート等で間違えることがあるので可能な限り解りやすい名前を付けましょう。
  • インポートをするとソースコードで見た時にどちらのクラス化判別するのか時間が掛かったり、勘違いをする可能性も起こるため別クラスと解りやすい名前を付けましょう。

プロジェクトで解りやすい名前を付けましょう。

変数

  • 基本的に「名詞」。
  • フラグは「動詞」+「名詞」で付ける。
  • 見た時にすぐに誰でも理解できる単語。
  • Suffixに変数の型を付けると間違えにくい。
  • プログラムの中で計算が発生刷る場合はNumber型を利用。
  • 主に表示に利用する場合はString型を利用。
  • 真偽の判定をする場合はBool型を利用しましょう。

Bool 系

ログインでの例

Prefix メソッド例 備考
is isLogin  ログインしてるか?
can canLogin  ログイン可能か?
should shouldLogin  ログインすべきか?
has hasLogin  ログインデータを持っているか?
needs needsLogin  ログインが必要か?

String 系

「名詞」の1単語だけで理解し難い場合は複数の単語を繋げる。

表示の変数の場合は基本的にString。

userName
usedCar

Number 系

loginCount の場合

カウント数を計算する場合は
loginCountNumber
※ Count、Numberと同じ単語が続くが、Numberは変数の型を明示的に示す。loginCount

表示用の場合は
loginCountString

メソッド

  • 命名する時は「動詞」+「名刺」で付ける。
  • 「動詞」はよく利用する動詞が決まっているので下記を参考にする。
  • 「名詞」はプロジェクトの仕様で異なるのでプロジェクトで解りやすい名前を付ける。
  • 「setter」「getter」は必ず「set」「get」。ただしBool系の場合は「is」。

よく使われる単語、Prefixの例

  • 基本的に自身に対しての操作の場合は「PreFix」だけを利用
    「initialize」
  • 自身のデータを初期化する場合は
    「initializeData」

フラグ系(bool)、状態を取得する時

Prefix メソッド例 備考
is isLogin()  ログインしてるか?
can canLogin()  ログイン可能か?
should shouldLogin()  ログインすべきか?
has hasLogin()  ログインデータを持っているか?
needs needsLogin()  ログインが必要か?

セッター、ゲッター

Prefix メソッド例 備考
get getName()  名前を取得
set setName()  名前を設定

オブジェクト設定系

初期設定

Prefix メソッド例 意味 備考
initialize initialize 初期化  オブジェクトのデータを初期化する時
init init 初期化  initializeの省略系
setup setup 設定  オブジェクトのデータを初期化する時
new new 新しく  新しくインスタンスを作成「newInstance」が多い
create create 作り出す 新しくインスタンスを作成する時
generate generate 生み出す 新しくインスタンスを作成する時
make make 作る 設定されたデータを利用して状態作成時
build build 組み立てる builder でインスタンスを作成する時
register register 登録する データ登録時

オブジェクトの状態を削除

Prefix メソッド例 意味 備考
erase eraseData 消す 所持しているデータのみを削除する時
trash trashData 捨てる 同上
clear clearData 綺麗にする 同上
delete deleteData 消去する 同上
restore restoreData 復元する データを元に戻す
reset resetData セットし直す 同上

オブジェクトを破棄

Prefix メソッド例 意味 備考
destroy destroy 破壊する 自身全体を破棄する
dispose dispose 処分する 同上
abandon abandon 中止する 同上

オブジェクトを更新

Prefix メソッド例 意味 備考
update update 更新 自身をアップデートする
upgrade upgrade 向上させる 自身をアップグレードする

オブジェクトを調整

Prefix メソッド例 意味 備考
adjust adjust 調整する 自身を調整する
adapt adapt 順応、適用 自身を調整する

オブジェクトの状態を削除

Prefix メソッド例 意味 備考
fix fix  正常に戻す  データを修正する

オブジェクトの状態を削除

Prefix メソッド例 意味 備考
parent parentNode 親オブジェクトにアクセスする場合
child childNode 子オブジェクトにアクセスする場合
children childrenNode 子供 子オブジェクト全体にアクセスする場合
self self 自分 自分自身

状態設定系

アクティブ、非アクティブ

Prefix メソッド例 意味 備考
activate activateData 動作を起動 アクティブ
deactivate deactivateData 動作を停止 非アクティブ

許可、拒否

Prefix メソッド例 意味 備考
allow 許可 許可
deny 拒否 拒否

付着、取り外す

Prefix メソッド例 意味 備考
attach 取り付ける
detach 取り外す

利用可能、利用不可

Prefix メソッド例 意味 備考
available 利用可能
unavailable 利用不可

可能、不可能

Prefix メソッド例 意味 備考
enable 可能
disable 不可能

ロック、アンロック

Prefix メソッド例 意味 備考
lock ロック
unlock アンロック

開く、閉じる

Prefix メソッド例 意味 備考
open 開く
close 閉じる

表示、非表示

Prefix メソッド例 意味 備考
show 表示
hide 非表示

折りたたむ、展開

Prefix メソッド例 意味 備考
collapse 折りたたむ
expand 展開

有効、無効

Prefix メソッド例 意味 備考
valid 有効
invalid 無効

見える、見えない

Prefix メソッド例 意味 備考
visible 見える
invisible 見えない

検証する

Prefix メソッド例 意味 備考
validate 認証する
verify 検証する
ensure 保証する

上、下

Prefix メソッド例 意味 備考
up
down

ログイン、ログアウト

Prefix メソッド例 意味 備考
log in logIn ログイン
log out logOut ログアウト
sign in signIn ログイン
sign out signOut ログアウト

状態変更

Prefix メソッド例 意味 備考
change 変更
modified 修正
revised 改正
refresh 回復

コレクションデータ操作系

コレクションの個々のデータ操作

データの追加

Prefix メソッド例 意味 備考
add
append
insert
put
push
set

データの削除

Prefix メソッド例 意味 備考
remove
prepend
delete
pop
pull
release
unset

データの取得

Prefix メソッド例 意味 備考
get

コレクションデータ位置、状態系

先頭

Prefix メソッド例 意味 備考
head
header
top
over
first
top 一番上
peak 山の山頂
spike 急増

末尾

Prefix メソッド例 意味 備考
tail
footer
bottom
under
last

現在の

Prefix メソッド例 意味 備考
previous

以前状態

Prefix メソッド例 意味 備考
before 以前の状態を取得
forward データを進める
old 古い

次の状態

Prefix メソッド例 意味 備考
after 次の状態を取得
backward データを戻す
next 次の
new 新しい

前方、後方

Prefix メソッド例 意味 備考
foreground 優先度を前方へ、見た目の場合、位置を前
background 優先度を後方へ、見た目の場合、位置を後ろ

進める、戻す

Prefix メソッド例 意味 備考
go 進める
back 戻す

範囲

Prefix メソッド例 意味 備考
within 範囲内
contains 含まれているか?

以外

Prefix メソッド例 意味 備考
exclude
ignore

範囲

Prefix メソッド例 意味 備考
limits 限界
bounds 境界
range 範囲

ストレージ系

接続、切断

Prefix メソッド例 意味 備考
connect 接続
disconnect 切断

同期、非同期

Prefix メソッド例 意味 備考
async 同期
sync 非同期

投稿

Prefix メソッド例 意味 備考
post 投稿

読み込み

Prefix メソッド例 意味 備考
load データを読み込む
read 設定を読み込む

書き込み

Prefix メソッド例 意味 備考
write データを書き込む
save 設定を書き込む

作成

Prefix メソッド例 意味 備考
create データを作成

更新

Prefix メソッド例 意味 備考
update データを更新

削除

Prefix メソッド例 意味 備考
delete データを削除

除去

Prefix メソッド例 意味 備考
remove データを除去

保存

Prefix メソッド例 意味 備考
save 保存
store
commit
apply

クリアー

Prefix メソッド例 意味 備考
clear クリアー
reset 初期化

入力、出力

Prefix メソッド例 意味 備考
input 入力
output 出力

インポート、エクスポート

Prefix メソッド例 意味 備考
import インポート
export エクスポート

実行系

検索

Prefix メソッド例 意味 備考
find 検索
search 検索

実行

Prefix メソッド例 意味 備考
start 検索
begin 検索
execute 検索

それでもネーミングに困った時は

それでもネーミングに困った時は以下のサイトで検索することができます。

日本語を入力するとオススメのネーミングが表示されます。

タイトルとURLをコピーしました