2017-10-17 6 views
3

私は、この質問が、私がコーディングに費やす時間のかなりの部分を取るので、閉鎖/降落されないことを願っています。コード内の単語を短縮するための最良の標準は何ですか?

Pythonに焦点を当てた開発者として、私はPEP8標準に準拠しようとしていますが、いくつかの変数名ではそれが本当に難しいものになります。

TEMPERATUREという単語を使用します。

私は温度のリストを格納する変数を持つようにしたい場合は、私はそれに名前を付けます:コードはより複雑になるにつれて

temperature_list = [] 

しかし、のは、私がtemperature_listで関数をコールするとしましょう引数として:

calling_function(variable_with_long_name, temperature_list, another_long_name_variable) 

それがつながる場所をはっきりと見ることができます...

は、だから私はtemp_listtemperature_listの名前を変更することを決定しました。どちらが良い選択肢として聞こえますか?私は、リスト内の一時ファイルを保存したい場合は、私が持って発生する可能性があり

...除き

temp_list = [] 
temp_file_list = [] 

それは私の変数をいじりして開始ポイントに来るかもしれませんコードをちょっと難しくしてフォローしましょう。

このような状況に直面したときに、どのような規則があり、プログラマは他に何をしますか?特定の名詞のための良い変数名のケースブックのような、そのような場合のための参照はありますか?

- あなたはそれを閉じるために投票した場合、少なくとも理由を説明、

を編集! - '

+4

PEP 8では、「実装ではなく、用途を反映しています」と表示されています。これは、ほとんどの場合、変数名に型名を含めないでください。名前を単に「温度」にすることは、読者に「これは反復可能で、おそらく索引付けされた非スカラー・オブジェクトである」ことを示すには十分であるはずです。 (これは私自身の主観的解釈であるためコメントではなく、答えとして投稿してください) – Kevin

+1

あなたのキャリアの中で、「TEMPERATURE」や「TEMPORARY」のような言葉が必要な回数は非常に少なくなります。現実世界では、あなたが合理的なコードを書いていれば、ロングネームはあまり問題になりません。 –

+0

@ケビンあなたは答えとしてあなたのコメントを再投稿する必要があります。 –

答えて

1

通常、あなたは長すぎない賢い名前を見つける必要がありますが、変数は正しく説明されています。これが失敗した場合や、類似した作業を行っている変数が多すぎる場合(近い名前になるため)、ドキュメントストリングまたはコメント内の変数を説明し、短い名前(a、bなどではなく意味のある名前)を指定できます。あなたは本当に、私は時々自分自身を避けることができない、長い変数名の必要性を持っている場合は、コードの目的を壊していないながら...)

def function(a, b): 
    """ 
    l_variable used for bla bla, 
    lo_variable is good for bla bla. 
    """ 

    l_variable = 12 
    lo_variable = 123 
    lon_variable = 1234 # This is an integer bla bla 

は、私は下の行の長さにしてみてください。たとえば、関数呼び出しの行を破る(例のように)。

def f(a, b, c): 
    print a + b + c 

this_is_a_long_variable_name = "Stack" 
this_is_an_even_longer_variable_name = "Over" 
this_is_the_longest_variable_name_in_this_example = "flow" 

f(this_is_a_long_variable_name, 
    this_is_an_even_longer_variable_name, 
    this_is_the_longest_variable_name_in_this_example) 
関連する問題