JavaScriptでの引数からオブジェクト生成する際の引数命名規則

Question

ブロックチェーン関連のコードを書いているのですが
以下のようなaddTransactionメソッドがあったとします。この場合、引数にはアンダースコアは付けるべきですか？
transactionというオブジェクトのプロパティと引数の名前が一緒なので、アンダースコアを付けた方がわかりやすいかと思いました。
ただ、そのルールだと、validChainにはアンダースコアなしとなり、統一性がないようにみえて気になります。
関数/メソッドの引数の命名規則が調べてもデファクトスタンダートが分からず。
どなたか教えてくれますか？

class BlockChain {
  .....
  addTransaction(_senderAddress,_recipientAddress, _amount) {
    const transaction = {
      senderAddress: _senderAddress,
      recipientAddress: _recipientAddress,
      amount: _amount
    }
    this.transactionPool.push(transaction);
    return transaction;
  }
  ......
  validChain(chain) {
    let _previousHash = this.hash(GENESIS_ADDRESS);
    chain.every((block) => {
      if(block.previousHash !== _previousHash) {
        return false;
      }
      if(!this.validProof(block.transactions, _previousHash, block.nonce)) {
        return false;
      }
      _previousHash = this.hash(block);
    });
    return true;
  }
}

※追記:
validChainの書き方間違えてました。質問の本質ではないですが、修正内容載せておきます

  validChain(chain) {
    let _previousHash = this.hash(GENESIS_ADDRESS);
    return chain.every((block) => {
      if(block.previousHash !== _previousHash) {
        return false;
      }
      if(!this.validProof(block.transactions, _previousHash, block.nonce)) {
        return false;
      }
      _previousHash = this.hash(block);
      return true;
    });
  }

Answer 1

こんにちは

ご質問について、回答したいことが以下の(1),(2)の2点あります。

• (1)は、開発上の個人的な設定に関することで、誰にでも当てはまる内容ではないです。
• (2)は、ご質問にあるコードに対するコメントになります。

(1) '_'を引数(ふくめ変数)の先頭に付けるときのＥＳLintの設定と意味

これは個々の開発環境によることなので、個人差があると思いますので、あくまで私の場合、ということになりますが、各引数の先頭に '_' を付けることはあります。ESLint をコードチェッカーに使うことが多いのですが、その際にたとえば以下のようなコード

function foo(x, y) {
    return x + 1;
}

を書くと、ESLintから以下のように、「変数 y が使われていない」旨を警告されます。

'y' is defined but never used. (no-unused-vars)

ですが、後々使いそうなy を引数に残しておいて、当面の間

function foo(x, y) {
    // TODO: y を使った計算結果で x を補正する。
    return x + 1;
}

としておきたい場合もあります。そのときに y ではなく _y と書いておくと、デフォルトでは

'_y' is defined but never used. (no-unused-vars)

というメッセージが出ますが、この警告を出さないように設定することができます。(設定の仕方はここに argsIgnorePattern として書いてあります。)

ESLintの設定の話になるので、この設定は強制されるものではありませんが、他の方もこれを設定されている例があるなど、ちょっと便利だったりもするので、「今は使っていないけれども、後々使いそうな変数を書いておいて、頭に '_' を付けて、ESLintの警告を回避する」という使い方に(個人的には)慣れてしまっています。

(2) ご質問に挙げられているコードについて

ご質問に挙げられているコードについて

transactionというオブジェクトのプロパティと引数の名前が一緒なので、アンダースコアを付けた方がわかりやすいかと思いました。

とありました。
引数と同じ名前のプロパティで、値としてその引数がそのまま使われていることを、分かりやすくするために、確かにご質問にある

addTransaction(_senderAddress,_recipientAddress, _amount) {
    const transaction = {
      senderAddress: _senderAddress,
      recipientAddress: _recipientAddress,
      amount: _amount
    }

という書き方もありなのかなと思いますが、

オブジェクトのプロパティと引数の名前が一緒

ということを、一見して分かるようにするには、以下のような書き方もできるかと思います。

addTransaction(senderAddress,recipientAddress, amount) {
    const transaction = {
      senderAddress,
      recipientAddress,
      amount
    }

オブジェクトtransaction を作る行がメソッド本体の一行目にあって、そこで Shorthand property names の書き方が使われていれば、 transaction のプロパティは、メソッドの引数を名前も値も同じで、そのまま入れるのだなと分かります。

以上、あくまで参考に留めて頂ければと思います。

Comments

[Satoshizzz]

ありがとうございます。`Shorthand property names`の書き方初めて知りました。
この書き方であればアンダースコアはいらなそうですね

[jun68ykt]

コメントありがとうございます。
はい。Shorthand property namesで、これまで、 { x: x, y: y } と書いていたのが、{ x, y } と書けるようになり、表記上の煩わしさがかなり軽減されたのと、x ,y という変数が、 { x, y } の前のどこかにあるはず、と読めるので便利です。