（最終更新日：2023年6月）
✔このような方へ向けて書かれた記事となります
「Pythonでコメントアウトを複数行行いたい」
「複数行のコメントアウトの書き方が知りたい」
「Pythonコメントアウトの実践的な例が見たい」
✔当記事を通じてお伝えすること
- Pythonのコメントアウトの基本知識
- 複数行コメントアウトの方法とその活用法
- Pythonでのコメントアウトの実践的な例
当記事では、Pythonのコメントアウトの基本から、複数行にわたるコメントアウトの方法まで、実用的な例を交えて詳細に解説しています。
ぜひ最後までお読みいただき、スキルアップを目指しましょう。
筆者プロフィール
【現職】プロダクトマネージャー
【副業】ブログ（月間20万PV）/YouTube/Web・アプリ制作
「プログラミング × ライティング × 営業」の経験を活かし、30後半からのIT系職へシフト。現在はプロダクトマネージャーとして、さまざまな関係者の間に入り奮闘してます。当サイトでは、実際に手を動かせるWebアプリの開発を通じて、プログラミングはもちろん、IT職に必要な情報を提供していきます。
【当ブログで紹介しているサイト】
✔人に見せても恥ずかしくないコードを書こう
「リーダブルコード」は、わかりやすく良いコードの定義を教えてくれる本です。
- 見るからにきれいなコードの書き方
- コードの分割方法
- 変数や関数の命名規則
エンジニアのスタンダートとすべき基準を一から解説しています。
何回も読むのに値する本なので、ぜひ手にとって読んでみてください。
はじめに
こちらでは、なぜコメントアウトについて学ぶべきかなどの基本概念について学びます。
- Pythonのコメントアウトの重要性
- 複数行のコメントアウトのメリット
Pythonのコメントアウトの重要性
Pythonのコメントアウトは、プログラム内でコメントを追加する際に使用します。
コメントはコードの実行には影響しませんが、コードの理解やメンテナンスに役立つもの。
プログラムの目的や複雑な部分の説明などを含めることが一般的です。
複数行のコメントアウトのメリット
複数行のコメントアウトは、長い説明や複数の段落を含む場合に特に便利です。
これにより、コードの構造や目的を明確にし、他の開発者や将来の自分がコードを効率的に理解できるようにします。
Pythonでのコメントアウトの基本
Pythonでのコメントアウトの基本的な書き方について解説します。
- 単一行コメントアウトの書き方
- 複数行コメントアウトの書き方
単一行コメントアウトの書き方
Pythonでは、#記号を使って単一行のコメントを書きます。
これは、その行の#以降のテキストはPythonインタープリタによって無視されることを意味します。
# これはコメントです
print("Hello, World!") # この部分もコメントです複数行コメントアウトの書き方
Pythonでは複数行のコメントには、連続した複数の単一行コメントやトリプルクォートを使って実現します。
# これは複数行のコメントです
# 2行目のコメントです
# 3行目のコメントです
"""
こちらも複数行のコメントです
2行目のコメントです
3行目のコメントです
"""トリプルクォートを使った複数行コメントアウト
こちらでは、トリプルクォートでコメントアウトする方法について、詳しく解説します。
- トリプルクォートの使い方
- 実践例：複数行のコメントアウトを用いたPythonコード
トリプルクォートの使い方
Pythonでは、トリプルクォート（""" または '''）を使って複数行にわたるコメントを作成できます。
トリプルクォートで囲まれた部分は、Pythonがマルチライン文字列として認識しますが、それを変数に代入しない限り、コメントとして機能するのです。
"""
これは複数行の
コメントです。
"""実践例：複数行のコメントアウトを用いたPythonコード
複数行のコメントは、関数の説明や、コードブロックの目的など、複雑なロジックを明確に説明する際に非常に役立ちます。
def add(a, b):
"""
この関数は、二つの数値を受け取り、
それらの合計を返します。
"""
return a + b
# 下記は、add関数の使用例です。
result = add(2, 3)
print(result) # 出力: 5開発環境別：コメントアウトのショートカットキー
こちらでは、主要なPython開発環境（PyCharm、Visual Studio Code、Jupyter Notebook）で使用されるコメントアウトのショートカットキーについて説明します。
- PyCharmのショートカットキー
- Visual Studio Codeのショートカットキー
- Jupyter Notebookのショートカットキー
PyCharmのショートカットキー
PyCharmでは、行をコメントアウトするには、以下のキーが使えます。
Ctrl + / キーこれを使って選択された複数の行を一度にコメントアウトすることも可能です。
Visual Studio Codeのショートカットキー
Visual Studio Codeでも、Ctrl + / キーを使用して行をコメントアウトします。
もしくは以下のキーで、複数行をブロックコメントとしてコメントアウトも可能です。
Shift + Alt + AJupyter Notebookのショートカットキー
Jupyter Notebookでは、Ctrl + / がコメントアウトのショートカットキーとして機能します。
また、セル内の複数行を選択し、同じキーの組み合わせを使用して、一度にコメントアウトも可能です。
コメントとドキュメントの書き方
こちらでは、関数やクラスへのコメント、具体的にはdocstringの記述方法と、規約に従った見やすいdocstringの書き方について解説します。
- 関数やクラスへのコメント（docstring）の記述方法
- 規約・ルールを守った見やすいdocstringの書き方
関数やクラスへのコメント（docstring）の記述方法
Pythonのdocstringは、関数やクラスの最初に記述される複数行の文字列のこと。
その関数やクラスの目的や使い方を文書化します。
通常、トリプルクォートを使って記述されます。
def add(a, b):
"""
二つの数値を受け取り、その合計を返します。
引数:
a (int): 最初の数値
b (int): 二つ目の数値
戻り値:
int: 二つの数値の合計
"""
return a + b規約・ルールを守った見やすいdocstringの書き方
PEP 257とは、docstringの書き方に関する公式ガイドです。
これに従って、簡潔かつ包括的なdocstringを書くことが推奨されています。
具体的には、以下のとおりです。
- 一行目に要約
- 空行を一つ開ける
- 詳細な説明、引数、戻り値等を記述する
以下がその例です。
def add(a, b):
"""
2つの数値を加算する関数です。
Args:
a (int): 加算される数値
b (int): 加算する数値
Returns:
int: 加算結果
Raises:
TypeError: aまたはbが数値でない場合に発生
Examples:
>>> add(2, 3)
5
>>> add(5, 7)
12
"""
if not isinstance(a, int) or not isinstance(b, int):
raise TypeError("aとbは整数である必要があります。")
return a + bJupyter Notebookでのdocstringの表示
こちらでは、Jupyter Notebook上でdocstringを表示する方法について解説します。
- help関数を使ったdocstringの表示
- Jupyter Notebookでのショートカットを利用したdocstringの表示
help関数を使ったdocstringの表示
Jupyter Notebookでは、help()関数を使って関数やクラスのdocstringを表示できます。
これは、インタラクティブな環境で迅速に情報を参照するのに役立ちます。
def example_function():
"""これはサンプル関数です。"""
pass
# docstringを表示
help(example_function)Jupyter Notebookでのショートカットを利用したdocstringの表示
また、Jupyter Notebookでは、関数名の後にShift + Tabキーを押すことで、docstringをポップアップ表示できます。
これは、コードを書きながら迅速にリファレンスを確認するのに非常に便利です。
import numpy as np
# 関数名のカーソル位置でShift + Tabキーを押してdocstringを表示
np.arrayこのショートカットキーは、簡潔に関数やクラスの概要を確認する際に大変便利です。
まとめ
当記事でお伝えしてきたことは以下のとおり。
- コメントは「#」やトリプルクォートでおこなう
- docstringは関数やクラスの振る舞いを明確にし、他の開発者や将来の自分自身にとって理解しやすいコードになる
- トリプルクォートを使用した複数行のコメントアウトは、長い説明やドキュメントを書く際に役立つ
コメントはコードの可読性を向上させ、プロジェクトの管理を効率化する重要な要素です。
また、開発環境によるコメントアウトのショートカットキーを利用することで、コーディング効率を向上させられます。
これらのテクニックを活用して、Pythonプログラムの可読性を向上させ、効率的なコーディングを心がけましょう。
今回学んだ知識を実際のプロジェクトに活かして、品質の高いコードを書く一助としてください。