python - Pythonに複数行のコメントがないのはなぜですか？

Question

OK、トリプルクォートの文字列が複数行のコメントとして機能する可能性があることは承知しています。例えば、

"""Hello, I am a 
   multiline comment"""

と

'''Hello, I am a 
   multiline comment'''

しかし、技術的に言えば、これらは文字列ですよね？

私はグーグルでPythonスタイルガイドを読みましたが、複数行の/ **/タイプのコメントが正式に実装されていない理由に対する技術的な答えを見つけることができませんでした。三重引用符を使用しても問題はありませんが、この設計上の決定につながった理由について少し興味があります。

score 281 · Accepted Answer

「グイドは複数行のコメントの必要性を感じなかった」よりも良い答えが得られるとは思えません。

Guido はこれについて次のようにツイートしています。

Python のヒント: 複数行の文字列を複数行のコメントとして使用できます。docstring として使用しない限り、コードは生成されません! :-)

score 60 · Accepted Answer

複数行のコメントは壊れやすいです。簡単な電卓プログラムに次のようなものがあるとしたら?

operation = ''
print("Pick an operation:  +-*/")
# Get user input here

複数行のコメントでコメントしてみてください：

/*
operation = ''
print("Pick an operation:  +-*/")
# Get user input here
*/

おっと、文字列に終了コメント区切り文字が含まれています。

score 38 · Accepted Answer

三重引用符で囲まれたテキストは、複数行のコメントと見なされるべきではありません。慣例により、それらはdocstringです。コードの機能と使用方法を説明する必要がありますが、コードブロックのコメントアウトなどについては説明しないでください。

Guido によると、Python の複数行のコメントは、連続した 1 行のコメントにすぎません(「ブロックコメント」を検索してください)。

コードブロックにコメントを付けるために、次のパターンを使用することがあります。

if False:
    # A bunch of code

score 30 · Accepted Answer

これは、タスクを実行するための明確な方法が 1 つあるはずであるというコアコンセプトに戻る可能性があります。コメントスタイルを追加すると、不要な複雑さが増し、読みやすさが低下する可能性があります。

score 12 · Accepted Answer

三重引用符は、docstring で複数行のコメントとして使用されます。そして # コメントはインラインコメントとして使用され、人々はそれに慣れます。

ほとんどのスクリプト言語には複数行コメントもありません。もしかしてそれが原因？

PEP 0008のセクションコメントを参照してください。

また、Python エディターがブロックコメント用のキーボードショートカットを提供しているかどうかを確認してください。Emacs は Eclipse と同様にそれをサポートしており、おそらくまともな IDE のほとんどがサポートしています。

score 9 · Accepted Answer

The Zen of Pythonから:

それを行う明白な方法が 1 つ (できれば 1 つだけ) ある必要があります。

score 5 · Accepted Answer

個人的には、Java での私のコメントスタイルは次のようなものです。

/*
 * My multi-line comment in Java
 */

したがって、スタイルが前の例に典型的である場合、単一行のみのコメントを使用することはそれほど悪いことではありません。

#
# My multi-line comment in Python
#

VB.NET は 1 行のコメントのみの言語でもあります。個人的には、コメントが好きなコメントではなく、ある種の引用のように見えるので、個人的には面倒です。

'
' This is a VB.NET example
'

単一行のみのコメントは、複数行のコメントよりも文字の使用が少なくなり、正規表現ステートメントで危険な文字によってエスケープされる可能性が低くなりますか? 私はネッドに同意する傾向があります。

score 4 · Accepted Answer

# This
# is
# a 
# multi-line
# comment

これを行うには、エディターでコメントブロックまたは検索と置換 (s/^/#/g) を使用します。

score 3 · Accepted Answer

これを解決するには、テキストエディター (TextPad) 用のマクロをダウンロードして行を強調表示し、各行の先頭に # を挿入します。同様のマクロは # を削除します。なぜ複数行が必要なのかと尋ねる人もいるかもしれませんが、デバッグ目的でコードのブロックを「オフ」にしようとしているときに便利です。

score 3 · Accepted Answer

Python で複数行のコメントを探している人にとっては、三重引用符形式を使用すると、問題のある結果が生じる可能性があります。このことを考慮：

this_dict = {
    'name': 'Bob',

"""
This is a multiline comment in the middle of a dictionary
"""

    'species': 'Cat'
}

複数行のコメントが次の文字列に押し込まれ、 'species'キーがめちゃくちゃになります。#コメントのみに使用することをお勧めします。

score 0 · Accepted Answer

# の規則は一般的なものであり、複数行のコメントでできることは # 記号のコメントでできることではありません。/* ... */PL/I にさかのぼるコメントの祖先のように、これは歴史的な事故です。

score 0 · Accepted Answer

それらが単に不必要であると考えられていたと仮定してください。と入力するだけで簡単にできるので#a comment、複数行のコメントは多くの 1 行のコメントで構成できます。

一方、HTMLの場合は、マルチライナーがさらに必要になります。タイピングし続けるのが難しくなります。

score 0 · Accepted Answer

これは単なる推測ですが..

それらは文字列であるため、何らかの意味値を持ちます (コンパイラーはそれらを削除しません)。それらは実際にはASTの一部になるため、ドキュメントの抽出が容易になります。

score 0 · Accepted Answer

その上、複数行のコメントは雌犬です。申し訳ありませんが、言語に関係なく、デバッグ目的以外には使用しません。次のようなコードがあるとします。

void someFunction()
{
    Something
    /*Some comments*/
    Something else
}

次に、デバッガーで修正できないコードが含まれていることが判明したため、これらの複数行コメントを使用してコードの小さな塊をどんどんコメントアウトして、手動でデバッグを開始します。これにより、次の関数が得られます。

void someFunction()
{ /*
    Something
   /* Comments */
   Something more*/
}

これは本当にイライラします。

score -1 · Accepted Answer

複数行のコメントを 3 重引用符で囲まれた変数に入れるという 1 人の男のことを読んだことを覚えています。

x = '''
This is my
super-long mega-comment.
Wow there are a lot of lines
going on here!
'''

これは少しメモリを消費しますが、複数行のコメント機能を提供し、さらにほとんどのエディターは構文を強調表示します:)

コードを次のようにラップするだけで、コードを簡単にコメントアウトすることもできます。

x = '''

と

'''

python - Pythonに複数行のコメントがないのはなぜですか？

18 に答える 18

Related

Reference