ドキュメント
Pythonで学ぶSoftware Engineeringの原則
Adam Spannbauer
Machine Learning Engineer at Eastman
Python のドキュメント
- コメント
# x の二乗
- Docstring
"""x の二乗を返す
:param x: 二乗する数
:return: x の二乗
>>> square(2)
4
"""
コメント
# 有効なコメント
x = 2
y = 3 # これも有効なコメント
# ソースコードを見ないと見えない# 未来の共同作業者へ！
効果的なコメント
「何」を書くコメント
# people を 5 に設定
people = 5
# people を 3 倍
people * 3
「なぜ」を書くコメント
# パーティ参加者は 5 人
people = 5
# 1 人あたりピザ 3 切れ必要
people * 3
Docstring（ドックストリング）
def function(x):
"""関数の概要
追加の詳細
Docstring（ドックストリング）
def function(x):
"""関数の概要
追加の詳細
:param x: パラメータ x の説明
:return: 戻り値の説明
Docstring（ドックストリング）
def function(x):
"""関数の概要
追加の詳細
:param x: パラメータ x の説明
:return: 戻り値の説明
>>> # 関数の使用例
使用例の想定出力
"""
# 関数本体
Docstring の例
def square(x):
"""x の二乗を返す
:param x: 二乗する数
:return: x の二乗
>>> square(2)
4
"""
# `x * x` は `x ** 2` より高速
# 参考: https://stackoverflow.com/a/29055266/5731525
return x * x
Docstring の出力例
help(square)
square(x)
x の二乗を返す
:param x: 二乗する数
:return: x の二乗
>>> square(2)
4
Let's Practice
Pythonで学ぶSoftware Engineeringの原則
