Pythonでdocstringを書く (Numpy-Style)
PyCharmだとAlt+Enterで自動生成してくれる
https://gyazo.com/2f80a95249bd4592b32783129ddc31fd
code:python
class Calculation:
"""
計算を行うクラス
Attributes
----------
x: int
引数
y: int
これまた引数
"""
def __init__(self, x: int, y: int):
self.x = x
self.y = y
def show(self, L: Liststr): """
Parameters
----------
L: list of str
型を詳細に書ける
"""
print(L)
def add(self, z: int = 10):
"""
Parameters
----------
z: int, default 10
足したい
Returns
-------
int
See Also
--------
mul: 掛け算の関数もある
Notes
-----
zはオプション変数のため入力しなくてもいい
Raises
------
ArithmeticError
もしマイナスならエラーとする
Examples
--------
>> c = Calculation(x=10, y=20)
>> print(c.add(z=30))
"""
res = self.x + self.y + z
if res < 0:
raise ArithmeticError
return res
def mul(self, z: int):
res = self.x * self.y * z
return res