Python のドキュメントとは
Python ドキュメント文字列とは、関数やクラスなどの説明文を記述するために使用します。
インタラクティブモード を起動して作業を行います。
VSCodeのターミナル画面を起動するか、Windows の Powershell を起動してください。
作業用フォルダに移動します。 フォルダはどこでもいいですが、他の作業と被らないように、新たに作るといいでしょう。
ここでは、作業用フォルダ "work" へ移動して ”python"と入力してインタラクティブモードを起動します。
下の画面は VSCode のターミナル画面ですが、Powershell でも同様です。
PS C:\>
PS C:\>cd work
PS C:\work> python
Python 3.14.0 (tags/v3.14.0:ebf955d, Oct 7 2025, 10:15:03) [MSC v.1944 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
Ctrl click to launch VS Code Native REPL
>>> ドキュメントは """（トリプルクォート）で記述
インタラクティブモードを起動したら、次に関数を入力します。
ここでは、addkansu という名称の関数で、パラメータは a と b で a + b を返すという関数です。
関数の説明文は、"addkansu()関数：引数a,b を加算して返します" とします。
下記のように入力して、実行してみます。
>>> def addkansu(a,b):
... """addkansu()関数：引数a,b を加算して返します"""
... c = a + b
... return c
...
>>> addkansu(2,3)
5
>>>上記の2行目が、ドキュメント文字列です。
この文字列は、help() で呼び出すことで説明文を画面に表示することができます。
>>> help(addkansu)
Help on function addkansu in module __main__:
addkansu(a, b)
addkansu()関数：引数a,b を加算して返します
>>>自作の関数やクラスは、上記のように入力することで help() で説明文が表示できます。
ドキュメント文字列は、複数行記載することもできます。
help() は組み込み関数やクラスの説明表示にも使用できます。
Python のコメントとは
Python のコメントとは、プログラムソースを編集するときに人が読むためのものです。
プログラムを処理するときには無視されるので、処理にはまったく影響しない記述です。
前述のドキュメント文字列が、その関数やクラスの説明として使用するのに対して、コメントはコーディングの説明として使用します。
コメントは '#' を使用
Python では、コメントを記入するときは '#' を使用します。
'#' 以降のアンダーライン部分がコメントです。
#処理名称 ← コメント：処理名称などを記載
a = 1 #変数aに1を代入します ← コメント：処理の説明などを記載
a += 10
コメント記述するときの注意点
コメント '#' を入れるときは 半角スペース で間隔を空けます。
半角スペースではなく全角スペースを使うと下記のようなエラーとなります。
>>> a = 1 # 全角スペースが '#' 前に入っているとこのようなエラーとなる
File "stdin.", line 1
a = 1 #コメント
^
SyntaxError: invalid non-printable character U+3000プログラムコードも同様に 全角と半角、大文字と小文字などのコーディングミスでエラーが発生ます。
些細なことですが、無駄な時間をかけることになるので、注意してコーディングしましょう。
結論、ドキュメントは関数やクラスの説明に使用して、コメントはコーディングのメモとして使用する