質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.83%

  • JavaScript

    14318questions

    JavaScriptは、プログラミング言語のひとつです。ネットスケープコミュニケーションズで開発されました。 開発当初はLiveScriptと呼ばれていましたが、業務提携していたサン・マイクロシステムズが開発したJavaが脚光を浴びていたことから、JavaScriptと改名されました。 動きのあるWebページを作ることを目的に開発されたもので、主要なWebブラウザのほとんどに搭載されています。

javaScript 変数命名規則について

解決済

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 446

いつもお世話になっております。

表題の通り、javaScriptの変数命名規則についての質問です。
素朴な質問なのですが、mapの第一引数は皆さんどのように変数名を付けていますか?

僕は以前map(i => hoge(i))の様に自分が認識できる変数名のつけ方をしていましたが考え直し以下の様に修正しました。

// NodeListを取得
const audioList = document.querySelectorAll("audio")

// 取得したDOMのクラス名をそのまま変数名につけている
Array.from(audioList).map((audioList, procIndex) => {
    // 割愛
})


以上の様に修正をしたのですが、少しめんどくささが残ります。
下記具体例です。

import request from 'superagent' // Ajaxライブラリ

// バイナリをAjaxで取得する
const getAudioBinaryChunk = (request_nane) => {
    if (!request_name) null // 割愛
    return new Promise((resolve, reject) => {
        request
            .post("/content")
            .query({query: request_name})
            .end((err, res) => {
               if(err) null // 割愛
               resolve(res.body)
        })
    })
}

// 元の変数名が長いと、後々めんどくさい
const audioBinaryChunk = getAudioBinaryChunk("hoge")

// Promiseの引数はresultとかでいいと思うが、mapはどうか疑問
audioBinaryChunk.then((result) => {
    result.map((audioBinaryChunk) => {
        const audioType = audioBinaryChunk.slice(1,8)
        // ...etc
    })
})

上記の例は少し現実味が薄いですが、伝えたいことはコメントの通りです。

変数命名などのノウハウや単純に上記のコードのご指摘があれば幸いです。

以上宜しくお願い致します。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

checkベストアンサー

+4

素朴な質問なのですが、mapの第一引数は皆さんどのように変数名を付けていますか?

以下を回答の前提としています。

  • 質問内でのmapArray.prototype.map()を指すということ
  • Array.prototype.map()の第一引数はcallback関数なので、質問はそのcallback関数の第一引数の命名についてであること

 匿名関数を渡す場合

const students = [
    { id: 1, name: 'John', score: 92 },
    { id: 2, name: 'Mike', score: 89 },
    { id: 3, name: 'Ken', score: 78 },
]

const scores = students.map(function(student) {
    return student.score;
});

console.log(scores); // [ 92, 89, 78 ]

例としてstudents配列があるとした場合、mapメソッドに渡すコールバック関数の第一引数には配列内の個々のstudentを表すオブジェクトが渡ってくる訳なので、そのまま、studentと命名するのが自然かなと思います。

Array.from(audioList).map((audioList) => {
    // 割愛
})


前述の説明をふまえると、質問文に掲載のコードの場合、mapメソッドに渡すコールバック関数の第一引数には配列が渡っているように読めてしまいます。

const audioList = Array.from(nodeList); 
audioList.map((audioList, index, array) => {
    // 割愛
})


Array.prototype.mapメソッドに渡すコールバック関数の第3引数には「mapが実行されている配列(audioList)」が渡ってきますので、第一引数の名前が複数形や「xxxList」のようなものだと、第3引数に渡ってくる配列と紛らわしくなると思います。(mapメソッドを使い慣れてる人は大丈夫でしょうけども)

Array.from(audioList).map((element) => {
    // 割愛
})


なので、elementaudioElementあたりが分かりやすいのではないでしょうか。

 名前付き関数を渡す場合

students.map(function(student) {
    return student.score;
});

無名関数の場合は、その場だけの用途になるので、上記のコードのようにstudentと具体的な命名で良いと思いますし、個人的には分かりやすいのでより好ましいとも思います。

const students = [
    { id: 1, name: 'John', score: 92 },
    { id: 2, name: 'Mike', score: 89 },
    { id: 3, name: 'Ken', score: 78 },
]

const products = [
    { id: 1, name: 'apple', price: 980 },
    { id: 2, name: 'banana', price: 1480 },
    { id: 3, name: 'peach', price: 1200 },
]

// `object`や`obj`のような抽象度を上げた名前
const prop = key => object => object[key]; // objectかどうかのチェックは省略

const getScore = prop('score');
const getPrice = prop('price');

const scores = students.map(getScore);
const prices = products.map(getPrice);

console.log(scores); // [ 92, 89, 78 ]
console.log(prices); // [ 980, 1480, 1200 ]

逆に使いまわせるように関数を変数に代入し、mapメソッドに渡すような場合ですと、汎用性を気にする必要があるので、命名も抽象度を上げることになると思います。

上記の例で言えば、objectという引数名が、mapメソッドに渡すコールバック関数の第一引数に該当することになります。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/05/25 22:35

    ご回答ありがとうございます!

    具体的なコードでご説明頂き、とても参考になりました。
    Listに対してElementで個要素を表現、汎用性を持たせるために命名の抽象度を上げる等、とても納得できます...。

    是非参考にさせて頂きたいと思います、ありがとうございます!

    キャンセル

+2

1つの言語に限ったことではないですが、

  • 3か月後に読んだときに自分でも分かるような名前、
  • 他の人が読んでも何が起きているか分かるような名前

であれば基本良いと思います。
あとは現場で命名規則・コーディング規約があればそれに従う形で。

「コメントは3か月後の自分に向けて書くもの」のような名言も見たことがあります。

あとは下記の記事なども参考にしてみてください。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/05/25 22:17

    ご回答ありがとうございます、3ヶ月というのがなんとも絶妙ですね。
    Qiitaでの投稿記事がとても参考になりました!
    Qiitaで検索の発想は正直無かったのでとても助かります、ありがとうございます!

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.83%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る

  • JavaScript

    14318questions

    JavaScriptは、プログラミング言語のひとつです。ネットスケープコミュニケーションズで開発されました。 開発当初はLiveScriptと呼ばれていましたが、業務提携していたサン・マイクロシステムズが開発したJavaが脚光を浴びていたことから、JavaScriptと改名されました。 動きのあるWebページを作ることを目的に開発されたもので、主要なWebブラウザのほとんどに搭載されています。