Insider[解決!Python]Pythonでコメントを書くには:解決!Pythonブロックコメント、インラインコメント、docstringを使ったコメントやドキュメントの基本的な記述方法を紹介する。Insider編集部]この記事は会員限定です。会員登録(無料)すると全てご覧いただけます。str(x)コメントの種類Pythonのコメントは「#」記号で始まり、行末で終了する。8では、コメントを次の2種類に分類している。ブロックコメントインラインコメントブロックコメントとは、行が#記号で始まるコメントのことだ(ただし、行頭から#記号までの間に空白文字を含むこともある)。ブロックコメントの例を以下に示す。lines.インラインコメントとは、ある行にコードを書き、それに続けて書かれたコメントのこと。以下にインラインコメントの例を示す。インラインコメントこの他にPythonではトリプルクオート文字列(「'''」または「"""」で囲まれたテキスト)をモジュール/関数/クラス/メソッドの定義の先頭に文字列リテラルとして記述することで、それらに関する説明を含んだコメントのように使用することがある(docstring、ドキュメント文字列)。以下にdocstringの例を示す。xブロックコメントブロックコメントはそれに続くコード全体に関する説明を記述するときに使用する。行頭に、またはブロックを示すインデントの後に「#」記号と半角空白文字を1つ続けて、その後にコメントの本文を記述する。str(x)この例では、先頭の2行はその後に続くコードの説明を記述するブロックコメントとなっていて、fizzbuzz関数の概要を述べている。fizzbuzz関数内部のブロックコメントは関数の本体とインデントを合わせている(実行時にコメントは無視されるので、実際にはインデントを合わせる必要はないが、見通しのよさを考えるとコードブロックのインデントとブロックコメントのインデントは合わせておいた方がよいだろう)。上の例では、関数本体にあるブロックコメントの内容は「if文で行っている処理をそのまま書き下したもの」であり、これはコードを見れば自明なので実際にはこうしたコメントは不要だろう。0が他の条件よりも先にあるのか」の方がまだましかもしれない(それすら不要だろう)。インラインコメントインラインコメントには、それを記述した行に書かれているコードに関する説明を記述する。その際、コードの後には半角空白文字を最低でも2つ、その後に#記号と半角空白文字を1つ続けてから、コメントを記述する。ブロックコメントと同様に、コードが自明であるときに、それをそのまま書き下したコメントは不要だ。8ではなるべく使わないようにすることが推奨されている。以下は上のブロックコメントをif文の各節にインラインコメントとして記述したものだが、コードに続くコメントがうるさく感じるし、コードそのままの説明なので意味がない。str(x)そうではなく、以下のように「15の倍数は3か5の倍数でもある」(から、最初に書いておく必要がある)といったコメントだけを記述した方がよいだろう。設定を有効にする必要があります。メールマガジンをご購読ください。申し込みページへITmediaはアイティメディア株式会社の登録商標です。