Python で関数にコメントを付ける適切な方法は何ですか? 質問する

Python で関数にコメントを付ける適切な方法は何ですか? 質問する

Python で関数にコメントを付ける一般的な方法はありますか? 次の方法は受け入れられますか?

#########################################################
# Create a new user
#########################################################
def add(self):

ベストアンサー1

正しい方法は、docstring を提供することです。そうすれば、help(add)コメントも出力されます。

def add(self):
    """Create a new user.
    Line 2 of comment...
    And so on... 
    """

コメントを開始するには 3 つの二重引用符を使用し、コメントを終了するにはさらに 3 つの二重引用符を使用します。有効な Python 文字列を使用することもできます。複数行である必要はなく、二重引用符を一重引用符に置き換えることもできます。

見る:ペップ257

おすすめ記事