Pythonのコメントはどう書きますか?


Pythonコードを書く時に、いいコードを実践すると、コードが簡潔で分かりやすくなります。組織コード、変数の設定、関数に意味のある名前は、いくつかの良い方法です。
もう一つのコードの可読性を高める方法は注釈を使うことです。一つの注釈は、コードの一部の人間が読むことができる説明または注釈を説明するために用いることができる。例えば、複雑な正規表現を書いたら、注釈を追加して、コードが何をしているかを説明してもいいです。
あなたのPythonコードにコメントを追加して、将来あなたのコードを読む時、多くの時間と努力を節約できます。例えば、数ヶ月前か数年前に書いた脚本を直したいです。なぜあなたがいくつかの複雑なコードを書いたのか覚えていないかもしれません。コメントを追加しない限り。この注釈は他の開発者にもあなたのコードとコードの目的を理解してもらうことができます。
コメントは短く、要点をカットするべきです。それらの分かりやすいコードを説明しないでください。
本文は主にPythonで注釈を作る基礎知識を説明する。
一、Pythonにコメントを書く
Pythonは井戸番号(#)の後のすべてを無視します。
コメントは行の先頭または他のコードに追加できます。

# This is a Python comment.
print("Hello World") # This is an inline Python comment.
井桁の後ろのスペースは強制的ではないが、注釈の可読性を高める。
文字列の中間にある井戸番号は、注釈の開始を意味しない。この時点では、単純な井戸番号です。

paragraph = "# Hash inside quotes is not a comment."

Comments should be at the same indent level as the code beneath it:

```py
def factorial(n):
 if n == 0:
 return 1
 else:
 # Use the factorial function
 return n * factorial(n-1)
テキストエディタが構文ハイライトをサポートすると、コメントは常に緑の代表を使用します。
注記スクリプトをデバッグする時にとても役に立ちます。行またはコードブロックを削除するよりも、彼らを一時的に注釈してください。

# for fruit in fruits:
# print(fruit)
二、Pythonの複数行のコメント(コメントブロック)
他の流行のプログラミング言語と違って、Pythonは単一のコメントだけをサポートします。
Pythonで複数行のコメントを作成する一番簡単な方法は、各行に一つのコメントを追加することです。

# This is the first line.
# This is the second line.
もう一つのオプションはdocstrigsを使うことです。
Doctringsは、モジュール、関数、クラス、方法をドキュメント化するための複数の行の文字列です。
一つのDoctringsは(""")で始まり、一行または複数行とすることができます。

"""This is
a multiline
docstring.
"""
Doctringsは技術的なコメントではありません。Doctringsがモジュール、関数、クラス、または方法の前に現れたとき、バイトコードで終了し、__doc__の特殊属性のオブジェクトになる。
あなたは単独の行の注釈を使うべきです。
三、Shebang
Pythonスクリプトを読むと、最初の行は#!文字で始まり、続いてPython解凍器のパスです。

#!/usr/bin/env python3
この文字列はshebangと呼ばれています。この文字列はオペレーティングシステムに教えられています。どのようなインタプリタを使ってファイルを解析するべきですか?シナリオはshebangで開始され、シナリオ入力pythonではなく、端末で直接実行される。
shebangは井戸の番号で始まるので、注釈として認識され、自動的にPythoonのインタプリタに無視されます。
四、まとめ
コメントを書くのはとても良い実践です。他の開発者を助けて、未来の自分を含めて、このコードが何をしているかを理解してくれます。
Pythonでは、すべて井桁で始まるものから行末までのものが、一部の注釈とされています。
以上がPythonの注釈の方法の詳細です。pythonの注釈に関する資料は他の関連記事に注目してください。