おぼえがき

過ちては則ち改むるにうんぬんかんぬん

関数のドキュメントについて(Python)

f:id:feci:20210726231508j:plain

Python3

 

関数のドキュメントについて。

def aaa(para1para2):
  """この関数についてのコメント(ドキュメント)はここに書きます。

  Args:
      para(int): 1つ目のパラメータです。
      para(str): 2つ目のパラメータです。

  Returns:
      bool: 戻り値はtrueかfalseです。

  """
  print(para1)
  print(para2)
  return True


#①Docstringsで関数内のドキュメントを出力する。
print(aaa.__doc__)


#②help関数でも同じことができる。
help(aaa)

Pythonでは関数についてのドキュメントは上記のような形式で当該の関数内に記述します。

そしてこの関数内のドキュメントは、Docstringsまたはhelp関数を使って出力することが可能です。

 

 

上記のプログラムの出力結果は、それぞれ以下のようになります。

 

①の出力結果

この関数についてのコメント(ドキュメント)はここに書きます。

 Args:
   para(int): 1つ目のパラメータです。
   para(str): 2つ目のパラメータです。

 Returns:
   bool: 戻り値はtrueかfalseです。

 

②の出力結果

aaa(para1, para2)
  この関数についてのコメント(ドキュメント)はここに書きます。

  Args:
    para(int): 1つ目のパラメータです。
    para(str): 2つ目のパラメータです。

  Returns:
    bool: 戻り値はtrueかfalseです。

 

 

このような機能が実装されているので、関数のドキュメントは当該の関数内にダブルクオーテーションで囲って記述するのがPythonのルールとなっています。

 

 

以上です。