[box02 title="この記事のINDEX"]
[/box02]
ドキュメンテーションの使い方
pythonのドキュメンテーションとは、関数やクラスなどを説明する文字列のことを言います。関数やクラスの直後に
"""
"""
とすると、help(クラス名)、help(関数名)とすることで、説明文を表示することができます。
def print_msg(msg):
"""
文字列msgを受け取り標準出力する関数
:param msg: 表示する文字列
:return: none """
print(msg)
class sample_class():
"""
このクラスでは、 プロパティ△△: 関数〇〇:〇〇をします。
"""
help(print_msg)
#↑help(print_msg)とすることで、関数print_msgの説明文"""~~"""で定義したドキュメンテーション文字列を表示することができます。
help(sample_class)
#↑help(sample_class)とすることで、クラスsample_classの説明文"""~~"""で定義したドキュメンテーション文字列を表示することができます。
関数アノテーションの使い方
pythonのアノテーションとは、関数に対する注釈のようなものです。アノテーションを使うとPyCharmなどで利用する際に、注釈を表示してくれるようになります。
def add_hello(msg: str) -> str:
#↑引数msgはstrであることを支持しています。
return "hello " + str
add_hello(12)
#↑引数としてstrで指定しているが、intで呼び出しているため、注釈が表示されます。
引数の注釈
def add_hello(msg: str) -> str:
#↑返り値がstrであることを支持しています。
return "hello " + str
msg = 12 + add_hello("aa")
#↑add_hello()は返り値がstrであることを指定していて、int + strになってしまうため注釈が表示されます。
返り値の注釈
