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

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

ただいまの
回答率

89.97%

[Python]他人が見ても分かりやす関数名や変数名について(lst, dct等)

解決済

回答 2

投稿

  • 評価
  • クリップ 1
  • VIEW 469

_Victorique__

score 1181

こういう議論をしたところで何か一つに定まるものじゃないと言われるかもしれませんが、
何かしらのヒントが得られればと思い質問しました。

大体困るのはコレクション型を使っている時です。
具体例をPythonを使ってあげると、

# 何かしらの単語のList
word_lst = ["aaa","bbb","ccc"]
words = ["aaa","bbb","ccc"]

# 何かしらの単語のDictionary
word_dct = {"aaa" : 1, "bbb" : 2, "ccc" : 3}
words = {"aaa" : 1, "bbb" : 2, "ccc" : 3}

# set, tuple 等も同様

正直今の自分はlstやdctに慣れてしまっています。ですが、lstやdctなどは何となく気持ち悪い
感じがしています。恐らく気持ち悪さの裏にはlist → lst, dictionary → dctの略だというのがそうさせている
ような気がします。
コードを書く上での話をすると、List型の場合は
word_lstよりもwordsの方がしっくりきます。
ですが辞書型の場合はそうもいかず、
word_dctの方が分かりやすいと思いました。(その他いい変数名があれば教えて欲しいです)

そもそもlst, dctなどのような変数名をつけないほうがいいのでしょうか?
他人が見ても分かりやすい変数名や関数名をつけるのは本当に難しいです。
宜しくお願い致します。

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

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

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

    クリップを取り消します

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

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

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

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

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

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

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

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

    質問の評価を下げる

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

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

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

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

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

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

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

    詳細な説明はこちら

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

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

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

回答 2

+5

そもそもlst, dctなどのような変数名をつけないほうがいいのでしょうか?

自分以外でコードを見た人がひと目でわかる名前であれば、なんでもよいです。
以下は個人的な好みです。

 配列

配列名は <単数>_list とするよりも、複数形にする派ですね。

# fruit_list = ['apple', 'pen', 'banana']
fruits = ['apple', 'pen', 'banana']

# 要素1つを参照するときは単数形にします。
for fruit in fruits:
    print(fruit)

 辞書

dict も複数形にします。

settings = {'width': 100, 'height': 200}

colors = {'red': (255, 0, 0), 'green': (0, 255, 0), 'blue': (0, 0, 255)}

なにかの対応関係を表している場合は <名前>_map もしくは <A>_to_<B>/<A>2<B> とします。

id_to_label = {1: 'apple', 3: 'orange', 4: 'peach'}

投稿

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2018/10/06 12:55

    回答ありがとうございます。
    辞書型でもsをつけるのは意外でした。
    今後のヒントにさせていただきます。
    有り難うございました!

    キャンセル

checkベストアンサー

+4

組み込み型のlistdictとカブるというのがlstdctを使う最大のモチベーションなので、質問文のケースはそもそも省略する必要があるケースに該当しません。

私なら基本的にはword_listword_dictにします。

wordsのように複数形にするかどうかはケースバイケースな気がします。型を明示した方がわかりやすいときと、型なんか示しても何の役にも立たないようなときがあるので。

あとは一時変数的な用途でlistdictそのものを使いたくなったときの処置が問題ですかね。個人的には、前者はlst、後者はdにしていることが多い気がします。

投稿

編集

  • 回答の評価を上げる

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

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

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

  • 回答の評価を下げる

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

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

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

  • 2018/10/06 12:54

    回答有難うございます。
    *_listが良かったり*sの方が良かったりがあるとのことですが、
    それらを混在させることはさほど問題ないのでしょうか?
    例えばなんですが、diseaseなどsをつけるだけでは分かりにくい場合もあります。
    なので私の場合はsやlistが混在してしまっています。

    キャンセル

  • 2018/10/06 17:29

    混在させてもあまり大きな問題はないと思いますが、たとえばチーム開発であれば「どんな基準で使い分けているのか」と議論になる前に統一しておいた方が良い、といったケースはあると思います

    キャンセル

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

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