Pylint会抛出一些文件缺少文档字符串的错误。我尝试将文档字符串添加到每个类、方法和函数，但似乎Pylint还检查文件是否应该在它们的开头有一个文档字符串。我可以以某种方式禁用它吗？我希望收到有关类、函数或方法中缺少文档字符串的通知，但文件不应强制要求具有文档字符串。(在专有源文件的开头是否经常出现法律术语的术语？有例子吗？我不知道单独发布这样一个琐碎的问题是否可以。) 最佳答案 Python模块最好有一个文档字符串，解释模块的作用、提供的功能以及如何使用类的示例。这与您经常在文件开头看到的提供版权和许可信息的注释不同，IMO不应
Pylint会抛出一些文件缺少文档字符串的错误。我尝试将文档字符串添加到每个类、方法和函数，但似乎Pylint还检查文件是否应该在它们的开头有一个文档字符串。我可以以某种方式禁用它吗？我希望收到有关类、函数或方法中缺少文档字符串的通知，但文件不应强制要求具有文档字符串。(在专有源文件的开头是否经常出现法律术语的术语？有例子吗？我不知道单独发布这样一个琐碎的问题是否可以。) 最佳答案 Python模块最好有一个文档字符串，解释模块的作用、提供的功能以及如何使用类的示例。这与您经常在文件开头看到的提供版权和许可信息的注释不同，IMO不应
我有一个带有文档字符串的Python脚本。当命令行参数解析不成功时，我想打印用户信息的文档字符串。有什么办法吗？小例子#!/usr/bin/envpython"""Usage:script.pyThisdescribesthescript."""importsysiflen(sys.argv)") 最佳答案 文档字符串存储在模块的__doc__全局中。print(__doc__)顺便说一句，这适用于任何模块:importsys;打印(sys.__doc__)。函数和类的文档字符串也在它们的__doc__属性中。
我有一个带有文档字符串的Python脚本。当命令行参数解析不成功时，我想打印用户信息的文档字符串。有什么办法吗？小例子#!/usr/bin/envpython"""Usage:script.pyThisdescribesthescript."""importsysiflen(sys.argv)") 最佳答案 文档字符串存储在模块的__doc__全局中。print(__doc__)顺便说一句，这适用于任何模块:importsys;打印(sys.__doc__)。函数和类的文档字符串也在它们的__doc__属性中。
PyCharm，当我开始输入文档字符串时，PythonIDE会为文档字符串生成一个模板。这是为简单函数生成的模板。defadd_them(x,y):""":paramx::paramy::return:"""z=x+yreturnz我没有发现它与Python的官方文档字符串有任何相似之处conventions.此模板是否与任何文档生成器(如readthedocs)一起使用？人们如何有效地使用？填写模板的正确方法是什么？谢谢。 最佳答案 我们将它与sphinx-apidoc一起使用来生成我们的HTML和PDF文档。这是我如何使用文档字
这个问题与thisotherone有关.建议和接受的解决方案是:Returns:(tuple):tuplecontaining:arg1:FirstArgumentarg2:SecondArgument此解决方案无效，至少对我而言。具有arg1和arg2描述的缩进子block不被解析。我应该如何使用sphinx、sphinx.ext.napoleon和GoogleStyledocstring管理多个返回？ 最佳答案 这是一个已知问题won'tbefixed由napoleon的当前维护者提供。尽管如链接中所述，他们欢迎贡献修复的拉取请
所以我查看了一些代码，并在pylint的帮助下将其提升到PEP8标准，我注意到如果我在打印语句中使用三引号，其中文本超过120个字符(我们允许120而不是79)pylint没有提示。这是pylint中的一个错误吗？三重引号中的字符串，因为您可能希望以这种方式格式化它们？为清楚起见:是的，pylint在所有其他超过行长度的情况下正常工作。 最佳答案 经常使用pylint，我也注意到了这种不一致。在MaximumLineLengthsectionofPEP8，它说:Therefore,pleaselimitalllinestoamaxi
我想使用Jedi为我的Python代码添加一些自动完成支持。.这可以通过使用函数文档字符串或类型提示(或两者)来完成。deffunction_with_types_in_docstring(param1,param2):"""Examplefunctionwithtypesdocumentedinthedocstring.:typeparam1:int:typeparam2:str:rtype:bool"""deffunction_with_pep484_type_annotations(param1:int,param2:str)->bool:"""Examplefunctionwi
考虑这段代码:deftest():"""Thislineislongerthan80chars,but,formethisisokinsideaDOCSTRING,thisoneisshorter."""if'Thisistoooooooooooooooooooooooooooooooooooolongggggggggggggggggggggggg':print'True'pylint输出:C:5,0:Linetoolong(84/80)(line-too-long)C:9,0:Linetoolong(83/80)(line-too-long)是否有任何可用的指令(rcfile)从py
考虑以下python代码:deffunction():"Docstring"name=???doc=???returnname,doc>>>function()"function","Docstring"我需要用什么来替换问号，以便从同一函数中获取函数的名称和文档字符串？编辑:到目前为止，大多数答案都明确地将函数名称硬编码在其定义中。是否可以执行类似下面的操作，其中新函数get_name_doc将从调用它的外部框架访问该函数，并返回其名称和文档？defget_name_doc():???deffunction():"Docstring"name,doc=get_name_doc()re
