Python のクラスにコメントを書いて __doc__ で表示する
2023.02.18
Python のクラスに書かれたコメントはインスタンスやクラスから __doc__ で表示されます。
class User:
"""ユーザーの
名前と年齢を管理する"""
def __init__(self, name, age):
self.id = 0
self._name = name
self._age = age
a = User(name='Alice', age=27)
print(a.__doc__)
# ユーザーの
# 名前と年齢を管理する
print(User.__doc__)
# ユーザーの
# 名前と年齢を管理する
コメントはクラスの名前のすぐ下に書き、""" ではさみます。コメントの上になにかがあると
class User:
gender = ''
"""ユーザーの
名前と年齢を管理する"""
def __init__(self, name, age):
self.id = 0
self._name = name
self._age = age
print(User.__doc__) # None
__doc__ は None を返します。
上は PyCharm の画面。__doc__ は灰色、コメントは緑色になる。
