Docstrings
コードスタイル
関数のDocStrings
"""text"""
3つの引用符で囲んで書く.def example_func(param1, param2):
"""Example function with types documented in the docstring.
Args:
param1 (int): The first parameter.
param2 (int): The second parameter.
Return:
bool: The return value. True for success, False otherwise.
"""
print(param1)
print(param2)
return Ture
関数の説明では、関数に「text」を使用します.
1.まず、上部に関数の内容を説明します.
2.args:のパラメータの説明
3.return:戻り値の説明
次のコードを実行して、関数のコメントを出力します.print(example_func.__doc__)
>Example function with types documented in the docstring.
Args:
param1 (int): The first parameter.
param2 (int): The second parameter.
Return:
bool: The return value. True for success, False otherwise.
help(example_func)
>Help on function example_func in module __main__:
example_func(param1, param2)
Example function with types documented in the docstring.
Args:
param1 (int): The first parameter.
param2 (int): The second parameter.
Return:
bool: The return value. True for success, False otherwise.
Reference
この問題について(Docstrings), 我々は、より多くの情報をここで見つけました
https://velog.io/@sayxyoung/python-codestyle-func-docstrings
テキストは自由に共有またはコピーできます。ただし、このドキュメントのURLは参考URLとして残しておいてください。
Collection and Share based on the CC Protocol
def example_func(param1, param2):
"""Example function with types documented in the docstring.
Args:
param1 (int): The first parameter.
param2 (int): The second parameter.
Return:
bool: The return value. True for success, False otherwise.
"""
print(param1)
print(param2)
return Tureprint(example_func.__doc__)
>Example function with types documented in the docstring.
Args:
param1 (int): The first parameter.
param2 (int): The second parameter.
Return:
bool: The return value. True for success, False otherwise.
help(example_func)
>Help on function example_func in module __main__:
example_func(param1, param2)
Example function with types documented in the docstring.
Args:
param1 (int): The first parameter.
param2 (int): The second parameter.
Return:
bool: The return value. True for success, False otherwise.
Reference
この問題について(Docstrings), 我々は、より多くの情報をここで見つけました https://velog.io/@sayxyoung/python-codestyle-func-docstringsテキストは自由に共有またはコピーできます。ただし、このドキュメントのURLは参考URLとして残しておいてください。
Collection and Share based on the CC Protocol