Python 代码注释

Question

在 C# 和 Visual Studio 中，可以注释你的函数，这样你就可以告诉谁在使用你的类，输入参数应该是什么，它应该返回什么，等等。在 python 中有什么远程相似的东西吗？

Answer 1

在 Python 中你使用 docstrings像这样:

def foo():
    """ Here is the docstring """

基本上，您需要将三引号字符串放在函数、类或模块的第一行才能被视为文档字符串。

注意:实际上，您不必使用三引号字符串，但这是惯例。任何 liter 字符串都可以，但最好遵循约定并使用三引号字符串。