スポンサーリンク
スポンサーリンク

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

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

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

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

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

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

基本的なルール

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

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

クラス

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

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

変数

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

Bool 系

ログインでの例

Prefixメソッド例備考
isisLogin ログインしてるか?
cancanLogin ログイン可能か?
shouldshouldLogin ログインすべきか?
hashasLogin ログインデータを持っているか?
needsneedsLogin ログインが必要か?

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メソッド例備考
isisLogin() ログインしてるか?
cancanLogin() ログイン可能か?
shouldshouldLogin() ログインすべきか?
hashasLogin() ログインデータを持っているか?
needsneedsLogin() ログインが必要か?

セッター、ゲッター

Prefixメソッド例備考
getgetName() 名前を取得
setsetName() 名前を設定

オブジェクト設定系

初期設定

Prefixメソッド例意味備考
initializeinitialize初期化 オブジェクトのデータを初期化する時
initinit初期化 initializeの省略系
setupsetup設定 オブジェクトのデータを初期化する時
newnew新しく 新しくインスタンスを作成「newInstance」が多い
createcreate作り出す新しくインスタンスを作成する時
generategenerate生み出す新しくインスタンスを作成する時
makemake作る設定されたデータを利用して状態作成時
buildbuild組み立てるbuilder でインスタンスを作成する時
registerregister登録するデータ登録時

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

Prefixメソッド例意味備考
eraseeraseData消す所持しているデータのみを削除する時
trashtrashData捨てる同上
clearclearData綺麗にする同上
deletedeleteData消去する同上
restorerestoreData復元するデータを元に戻す
resetresetDataセットし直す同上

オブジェクトを破棄

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

オブジェクトを更新

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

オブジェクトを調整

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

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

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

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

Prefixメソッド例意味備考
parentparentNode親オブジェクトにアクセスする場合
childchildNode子オブジェクトにアクセスする場合
childrenchildrenNode子供子オブジェクト全体にアクセスする場合
selfself自分自分自身

状態設定系

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

Prefixメソッド例意味備考
activateactivateData動作を起動アクティブ
deactivatedeactivateData動作を停止非アクティブ

許可、拒否

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 inlogInログイン
log outlogOutログアウト
sign insignInログイン
sign outsignOutログアウト

状態変更

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をコピーしました