Python の関数にドキュメントを書く：doc とインデント処理

Python のドキュメンテーション文字列は三重クォートで表現します。

def add(x, y):
	"""
	ただの足し算
	"""
	return x + y


s = add.__doc__

print('A' + s + 'B')

A
	ただの足し算
	B

インデントが入って気持ち悪いんですが……。

インデントを消したいときは textwrap の dedent を使います。

from textwrap import dedent


def add(x, y):
	"""
	ただの足し算
	"""
	return x + y


s = add.__doc__
s = dedent(s)

print('A' + s + 'B')

A
ただの足し算
B

説明を文字列として保存する必要がない場合

ただ確認したいときは help もアリです。

def add(x, y):
	"""
	ただの足し算
	"""
	return x + y


help(add)

Help on function add in module __main__:

add(x, y)
    ただの足し算

標準出力（コンソール）にドキュメンテーションが出力されます。