我不知道print(__doc__)在脚本开头做了什么，例如inthisScikitexample.我一直在google中寻找Python文档字符串，似乎__doc__可以在函数中提供一些文档。但我看不到__doc__在脚本中间做了什么。 最佳答案 itseems__doc__isusefultoprovidesomedocumentationin,say,functions这是真的。除了功能之外，还可以在模块中提供文档。因此，如果您有一个名为mymodule.py的文件，如下所示:"""Thisisthemoduledocstri

我不知道print(__doc__)在脚本开头做了什么，例如inthisScikitexample.我一直在google中寻找Python文档字符串，似乎__doc__可以在函数中提供一些文档。但我看不到__doc__在脚本中间做了什么。 最佳答案 itseems__doc__isusefultoprovidesomedocumentationin,say,functions这是真的。除了功能之外，还可以在模块中提供文档。因此，如果您有一个名为mymodule.py的文件，如下所示:"""Thisisthemoduledocstri

我在使用带有装饰器的文档字符串时遇到问题。举个例子:defdecorator(f):def_decorator():print'decoratoractive'f()return_decorator@decoratordeffoo():'''themagicfoofunction'''print'thisisfunctionfoo'help(foo)现在帮助没有按预期向我显示foo的文档字符串，它显示:Helponfunction_decoratorinmodule__main__:_decorator()没有装饰器，帮助是正确的:Helponfunctionfooinmodule__

我在使用带有装饰器的文档字符串时遇到问题。举个例子:defdecorator(f):def_decorator():print'decoratoractive'f()return_decorator@decoratordeffoo():'''themagicfoofunction'''print'thisisfunctionfoo'help(foo)现在帮助没有按预期向我显示foo的文档字符串，它显示:Helponfunction_decoratorinmodule__main__:_decorator()没有装饰器，帮助是正确的:Helponfunctionfooinmodule__

已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。关闭4年前。Improvethisquestion我很快就开始了一个开源Python项目，我正在尝试提前决定如何编写我的文档字符串。显而易见的答案是使用带有autodoc的reStructuredText和Sphinx，因为我真的喜欢简单地在我的文档字符串中正确记录我的代码然后让Sphinx自动构建一个API文档我。问题在于它使用的reStructuredText语法——我认为它在渲染之前完全不可读。例如

已结束。此问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提出有关书籍、工具、软件库等方面的建议的问题。您可以编辑问题，以便用事实和引用来回答它。关闭4年前。Improvethisquestion我很快就开始了一个开源Python项目，我正在尝试提前决定如何编写我的文档字符串。显而易见的答案是使用带有autodoc的reStructuredText和Sphinx，因为我真的喜欢简单地在我的文档字符串中正确记录我的代码然后让Sphinx自动构建一个API文档我。问题在于它使用的reStructuredText语法——我认为它在渲染之前完全不可读。例如

我想从函数内部打印python函数的文档字符串。例如。defmy_function(self):"""Docstringformyfunction."""#printtheDocstringhere.目前我是在定义my_function之后直接执行此操作的。printmy_function.__doc__但宁愿让函数自己做。我尝试在my_function中调用printself.__doc__printself.my_function.__doc__和printthis.__doc__但这不起作用. 最佳答案 defmy_func(

我想从函数内部打印python函数的文档字符串。例如。defmy_function(self):"""Docstringformyfunction."""#printtheDocstringhere.目前我是在定义my_function之后直接执行此操作的。printmy_function.__doc__但宁愿让函数自己做。我尝试在my_function中调用printself.__doc__printself.my_function.__doc__和printthis.__doc__但这不起作用. 最佳答案 defmy_func(

Pylint会抛出一些文件缺少文档字符串的错误。我尝试将文档字符串添加到每个类、方法和函数，但似乎Pylint还检查文件是否应该在它们的开头有一个文档字符串。我可以以某种方式禁用它吗？我希望收到有关类、函数或方法中缺少文档字符串的通知，但文件不应强制要求具有文档字符串。(在专有源文件的开头是否经常出现法律术语的术语？有例子吗？我不知道单独发布这样一个琐碎的问题是否可以。) 最佳答案 Python模块最好有一个文档字符串，解释模块的作用、提供的功能以及如何使用类的示例。这与您经常在文件开头看到的提供版权和许可信息的注释不同，IMO不应

Pylint会抛出一些文件缺少文档字符串的错误。我尝试将文档字符串添加到每个类、方法和函数，但似乎Pylint还检查文件是否应该在它们的开头有一个文档字符串。我可以以某种方式禁用它吗？我希望收到有关类、函数或方法中缺少文档字符串的通知，但文件不应强制要求具有文档字符串。(在专有源文件的开头是否经常出现法律术语的术语？有例子吗？我不知道单独发布这样一个琐碎的问题是否可以。) 最佳答案 Python模块最好有一个文档字符串，解释模块的作用、提供的功能以及如何使用类的示例。这与您经常在文件开头看到的提供版权和许可信息的注释不同，IMO不应