㊙️

【決定版】誰も教えてくれない名前の読み方

2024/01/14に公開

【決定版】誰も教えてくれない名前の読み方

  1. 変数名は末尾を見ろ(処理をしない概念)
    A. 最重要単語は末尾(前置詞除く)
    "TableSize, reqFile, wantPort"
  2. 関数名は先頭を見ろ(処理をする概念)
    A. 最重要単語は先頭
    "addUserTag(), recoveryMiddleware(), CopyFromRows(), PrepareContext()"
  3. クラス名はカオスなのでgrep.appで人気リポジトリを参考に。
    A. "CurrentClockIndicator, UserProfilePresenter, CoinStatusResponse, CoinStatus, CreatedColumns, AddTask, Node"
  4. インターフェイス名はカオスなのでgrep.appで人気リポジトリを参考に。
    A. "onClicked, ReadWriter, DataStore, Warning, Orderable"

【決定版】誰も教えてくれない名前の付け方

名前の付け方の名前には変数名や関数名、クラス名があります。
名前の付け方は多くの本で議論されていますが、どれだけ本を読んでも答えにはたどり着けません。言葉とそれを理解する読者は生き物だからです。

Q.これらの名前の目的は何ですか?

A. 目的は、読者に処理内容を理解してもらうための目次の役割を果たします。

Q.読者とは誰を指しますか?

A. 読者は、自分自身およびコードを読む不特定多数の人々を指します。

Q.不特定多数の人々全てを納得させる目次は作れますか?

A. いいえ、作れません。

Q.不特定多数の人々全てを納得させる目次は作れますか?

A. いいえ、困難です。

Q.納得させる可能性の高い目次は作れますか?

A. はい、GitHub の人気リポジトリのソースコードからインスピレーションを得て、他の成功したプロジェクトの目次を参考にすることで、納得させる可能性は高まります。

Q.GitHub の人気リポジトリのソースコードを簡単に検索する方法はありますか?

A. はい、grep.app がお勧めです。

結論: 名前の付け方は GitHub の人気リポジトリ を参考にする。

  1. 検索例1
    serch_get_
  2. 検索例2
    serch_func
  3. 検索例3
    serch_class
  4. 検索例4
    serch_type_patch
  5. 猫の里親募集中
    cat

Discussion