「～を取得するか否か」というboolean変数の適切な名前

Question

下記のコードのような「各科目のテスト結果を取得する」メソッドがあった場合、
「英語の点数を取得するか否か」というboolean変数は、どんな名前が適切なのでしょうか？
wantEnglishResult変数にしましたが、

• 動詞から始まるためメソッド名に見える
• 「want(欲しい)」という曖昧な単語を使っている

点で、不適切だと思います。

かといって、englishやenglishFlagという単語は、trueの場合「取得する」のか「取得しない」のか分からないので、使いたくありません。

適切な名前を教えてください。

※コードのメソッド設計や引数の名前がよろしくないことは、気にしないでください。

/**
 * テスト結果を取得する
 * @param param どの科目を取得するかという情報
 */
function getTestResult(param) {
  var testResult = {}; //テスト結果
  if (param.wantEnglishResult) {
    testResult.english = englishPoint; //英語の点数を設定
  }
  if (param.wantJapaneseResult) {
    testResult.japanese = japanesePoint; //国語の点数を設定
  }
  if (param.wantMathResult) {
    testResult.math = mathPoint; //数学の点数を設定
  }
  return testResult;
}

//国語と数学の点数を取得
getTestResult({wantEnglishResult: false,wantJapaneseResult:true, wantMathResult:true});

Answer 1

要求という意味なら、 need, require, demand などが良いかもしれません。
needEnglishResult
requireEnglishResult
demandEnglishResult

フラグというを強調したいなら、 is や flag を頭につけるとよいかもしれません。
isNeedEnglishResult
flagNeedEnglishResult

Answer 2

param自体は処理をせず、外部にやってもらう形になるため、
「これを使ってください」ということを伝えなければなりません。

というわけでshouldUse~がいいんじゃないですかね。

リーダブルコードには、boolを返す名前は、is,has,can,shouldがいいよ的なことが書いてあったので
私はこうしています。

is + 名詞：(名詞)か？
has + 名詞：持っているか？
has + 過去分詞：やったか？
can + 動詞：できるか？
should + 動詞：すべきか？

Comments

[yuji38kwmt]

回答ありがとうございます。
「リーダブルコード」に書かれている内容が参考になったので、ベストアンサーに選ばせていただきます。

Answer 3

flag変数のように捉えていましたが、multiple に select するという意味では selectEnglish になると思います。

/**
 * 案1
 */
function getTestResult (param) {
}

getTestResult({selectEnglish: true, selectJapanese: true})
 

「select*** が重複してくどいので仮引数に select の意味を持たせればいいのでは」
というわけで改案。

/**
 * 案2
 */
function getTestResult (selectSubjects) {
}

getTestResult({English: true, Japanese: true })
 

「関数名を変更すれば仮引数の select もなくせるのでは」
「複数の中から複数を選択するのでflag変数を使わず、配列で指定すればすっきりするのでは」
というわけで改案。

/**
 * 案3
 */
function getTestScoreBySubjects (subjects) {
  var testScore = {Japanese: 90, English: 80, Math: 85};

  if (subjects.indexOf('Japanese') === -1) {
    delete testScore.Japanese;
  }

  if (subjects.indexOf('English') === -1) {
    delete testScore.English;
  }

  if (subjects.indexOf('Math') === -1) {
    delete testScore.Math;
  }

  return testScore;
}

getTestScoreBySubjects(['English', Japanese]);

関数名は getElementsByTagName に倣いました。
flag変数を使うのであれば、「出力するオブジェクトのプロパティ名に日本語を使うか」という意味で第二引数に useJapanese があると面白いと思います。
use*** は addEventListener の第三引数(useCapture) で見られます。

Answer 4

引数を「点数を取得したい教科のリスト」と見做し、返り値のオブジェクトのフィールド名と同じ物を使うというのはどうでしょう。同じ名前だと憶えやすいですしね。不要な教科用のフィールドを、返り値のオブジェクトに含めないのであれば、「指定した時に取得するのかしないのか分かりづらい」という事もないでしょう。

function getTestResult(needCurriculums) {
  var testResult = {};
  if (needCurriculums.english) { // プロパティ名で真偽判定する。偽と見做せる値、或いは未定義の時は取得しない
    testResult.english = englishPoint; //英語の点数を設定
  }

  // 略

  return testResult;
}

var needCurriculums = {
  english: true,
  japanese: true
};
var scores = getTestResult(needCurriculums);

「どうしても真偽値の変数名に名詞を使うのが気に食わない」という事であれば、引数を配列にしてもいいでしょう。

// 文字列の配列とするパターン
var scores = getTestResult(['english', 'japanese']);

或いは、教科を表す定数群を用意するとか。
DOMのXPathResultみたいな感じで。JSだと上書きできてしまうので微妙ですが……

function getTestResult(needCurriculums) {
  // 略
}
const CurriculumType = { // 各定数はビットOR演算で複数指定できるようにしておく。
  ENGLISH: 1,
  JAPANESE: 2,
  MATH: 4
  // 略
};

var scores = getTestResult(CurriculumType.ENGLISH | curriculumType.JAPANESE);

特に配列やフラグの例は、そもそも関数のインタフェイス自体が変わっているので、yuji38kwmtさんの求める回答ではないかもしれません。しかし、「『いくら考えても、どうにもしっくりくる名前が見当たらない』という場合は、『そもそも現在の設計は妥当か』を考えなおしてみる良い機会である」という考え方を持つのも一興かと思います。

Answer 5

本質的にどう使うのかよく分からないのですが、
「取得する・しない」ではなく「使う・使わない」ではないでしょうか。
だとするとuseが自然ではないかと思います。「useJapaneseResult」

で、さらに「JapanesePoint」を使うかどうかなら
「useJapanesePoint」がいいんじゃないかなと。

さらにさらに、テストの点数とかなら、「Score」の方が適切ではないかと。
結論として「useJapaneseScore」がより自然かと思います。

Answer 6

要件を満たしていないような気もしますが、
getTestResult({ wantEnglish: true, wantJapanese: true }) ではなくて、
getTestResult({ target: ['english', 'japanese'] })みたいにするのが好みです。

Answer 7

Javaだとhasを使うことが多いですね
JavaScriptの命名規則かといわれると自信ないですけど。

”hasEnglishResult”なんてどうでしょう？

Answer 8

englishRequired とかですかねー
あとはメソッド呼ぶときのオプションということを考慮して、withEnglish とかもありかもですね

getTestResult({ withEnglish: true, withJapanese: true })

みたいな感じで呼べるのどうでしょうか

Answer 9

自分もneedがいいかなーと思いました。

ちなみにObjective-Cだと
getHogeIfNeededみたいなメソッドがあったりします。

Answer 10

意図を読むと「その結果が欲しいかどうか」のように見えたので，requestsとかですかね？

Answer 11

resultでもいいのですが、boolean型を明確にするためにflagはいかがでしょうか？

Answer 12

OSやVMMといったシステムソフトウェアをいじっている人間です．
Xenのハイパーコールという関数呼び出しのようなものの仕様が参考になると思いました．

「param」ではなく「cmd」（コマンド）という変数名にすると
「cmd.getJapaneseResult」などのようにできて，意味も明確になると思います．