如何获取要在快速文档弹出窗口中列出的类属性？
我发现Quick Documentation没有显示在类的文档中列出的属性，这真的很烦人。我认为原因是文档字符串格式不正确或不受支持，但reST和Google样式的行为是相同的(我在Python Integrated Tools中正确设置了它们)。 我当前的文档字符串样式为Google。让我在图片中显示问题所在： 这里是Actor类。 如您所见，Attributes部分显示在文档字符串中，
..
docstring相关内容
避免来自父对象的文档字符串，在Sphinx中
我将Sphinx用于自动文档，但我发现它在默认情况下将父类docstring追加到我的文档字符串中的方式很烦人。 结果是，对于从unittest.TestCase继承的每个文档化测试类，我都会得到文档字符串“创建执行时将使用命名测试方法的类的实例。如果实例没有具有指定名称的方法，则引发ValueError。”。因此，这两句话一遍又一遍地散落在我的测试文档中。 如何阻止Sphinx从父级
..
在Python中使用自定义文档字符串的方法和属性别名
我实现了以下修饰符： class alias(object): """ A decorator for implementing method aliases. """ def __init__(self, *aliases): self.aliases = set(aliases) def __call__(self, obj
..
Sphinx未正确呈现文档字符串中的数学表达式
我一直在尝试找出我的文档字符串中的这个表达式有什么问题。我使用的是pythonsphinxv1.2b中的sphinx.ext.mathjax扩展。文档字符串： .. math:: w_k^* = min_{w_k} ell_k(w_k) + lambdaleft(alpha||w_k||_1 + frac{1}{2}(1-alpha) ||w_k||^2 ight)
..
引用Python文档字符串中的参数
我使用Sphinx和Autodocs功能来确保我们的项目中有好的文档。 所以我熟悉info field lists，也熟悉在我们的文档中使用cross-referencing。 但是，在为方法或函数编写文档字符串时，我发现在文本中引用它们的参数很有用。但似乎没有一种结构化的方式来做到这一点。 我们可以说 Use ``name`` to set the username 但这
..
如何使用Sphinx标记引用有文档记录的Python函数参数？
我想在一个Python文档字符串中的其他地方引用前面介绍过的函数参数。请考虑以下(诚然完全是人为的)示例： def foo(bar): """Perform foo action :param bar: The bar parameter """ def nested(): """Some nested function that depen
..
Python代码中注释和文档字符串的基本语法
我正在学习如何使用Sphinx为我的代码创建文档。在我看到一些这样的例子后： def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part
..
如何在Sphinx处理的文档字符串中表示单个参数或返回值的多个类型？
有时，Python中的函数可能会接受灵活类型的参数。或者，它可以返回灵活类型的值。现在我记不起这样一个函数的好例子了，所以我在下面用一个玩具例子演示这样的函数可能是什么样子。 我想知道如何使用Sphinx文档表示法为这些函数编写文档字符串。在下面的示例中，参数可以是str或int。同样，它可能返回str或int。 我给出了一个文档字符串示例(既使用默认的Sphinx表示法，也使用Sph
..
最常见的Python文档字符串格式是什么？
我在Python中看到了几种不同样式的文档字符串，最流行的样式是什么？ 推荐答案 格式 Python文档字符串可以按照其他帖子中显示的几种格式编写。但是，没有提到默认的Sphinx文档字符串格式，该格式基于睡觉。您可以在this blog post中获取有关主要格式的一些信息。 请注意，PEP 287推荐使用睡觉 以下是文档字符串的主要使用格式。 -电子邮件
..
没有返回任何内容时的文档字符串
当函数不返回任何内容时，文档字符串的约定是什么? 例如: def f(x):"""打印作为输入给定的元素参数:x:任何元素回报:"""print "你的输入是 %s" % x返回 我应该在文档字符串中的 Returns: 之后添加什么?没有现在的样子? 解决方案 你应该使用 None，因为这是你的函数实际返回的: """打印作为输入的元素参数:x:任何元素回报:没有任何"""
..
扭曲的文档字符串中这些格式的含义是什么?
在twisted的源代码中，很多文档字符串包含这样的格式:L{xxx}或C{xxx}或以'@'开头的行，它们的含义是什么? 例如，在twisted/internet/interfaces.py中: def registerProducer(生产者，流媒体):"""注册以接收来自生产者的数据....对于 L{IPullProducer} 提供者，将调用一次 C{resumeProducing
..
如何使 Python/Sphinx 文档对象属性仅在 __init__ 中声明?
我有带有对象属性的 Python 类，这些对象属性仅在运行构造函数时声明，如下所示: 类 Foo(object):def __init__(self, base):self.basepath = 基础温度 = []在 os.listdir(self.basepath) 中运行:如果self.foo(运行):temp.append(运行)self.availableruns = 元组(排序(临时)
..
在 Python 中继承方法的文档字符串
我有一个 OO 层次结构，其中包含与代码本身一样多的维护的文档字符串.例如， class Swallow(object):定义空速(自我):"""返回空速(空载)"""引发 NotImplementedError类非洲燕子(燕子):定义空速(自我):# 任何 现在，问题是 AfricanSwallow.airspeed 没有继承超类方法的文档字符串.我知道我可以使用模板方法模式保留文档字符串，
..
将 javadoc 用于 Python 文档
我目前开始使用 Python，我有很强的 PHP 背景，并且在 PHP 中我养成了使用 javadoc 作为文档模板的习惯. 我想知道 javadoc 在 Python 中是否有其作为 docstring 文档的位置.这里有哪些既定的惯例和/或官方准则? 例如像这样的东西是否过于复杂而无法适应 Python 的思维方式，还是我应该尽量简洁? """用值替换模板占位符@param st
..
如何在 PHP5 对象中查找注释?
我希望能够在我的 PHP5 对象中实现自定义注释，并且我想通过构建我自己的解析器来了解整个过程是如何工作的. 不过，首先，我需要知道如何查找注释. 是否有我缺少的反射方法，或者还有其他方法吗? 例如，我希望能够在类中找到以下注释: /*** @MyParam: 我的价值*/ 解决方案 您可以使用 ReflectionClass::getDocComment，例如: fun
..
Visual Studio Code 支持的 Python 文档字符串格式是什么?
VS Code 如何在鼠标悬停时解释 Python 文档字符串中的标记/降价和布局? 此显示报告了几个问题，但似乎没有关于当前格式是什么的任何官方信息. 解决方案 VS Code 在鼠标悬停时可以很好地呈现 Markdown - 但不能很好地呈现标准文档字符串格式 VS Code Python 扩展将使用您放入文档字符串中的 Markdown 以获取智能感知鼠标悬停信息，但这并
..
我已经使用这个 docstring 语法 2 年了，它叫什么，谁指定的，它是否“好"?使用它?
我已经使用这种奇怪的语法很长时间了，而且我已经很擅长了.这就像将 Java 的优点放在了 Python 中.太棒了，我喜欢，我的IDE甚至因为注释而发现了一些错误. 但是我不知道是谁指定了这个语法，它的官方程度，我也不知道它的确切规则. 诚然，我正在使用 PyCharm，但我不知道这是否适用于其他 IDE，或者它是否只是 PyCharm 语法 - 我不想认为它是，我想使用也适用于其他工
..
让 Sphinx 替换文档字符串文本
我在 Sphinx 中记录类似于此的代码: class ParentClass(object):def __init__(self):经过def generic_fun(self):""""使用/run/ParentClass/generic_fun()"""调用此函数做东西()类子类(父类):def specific_fun(self):""""使用/run/ChildClass/specif
..
不返回任何内容时的文档字符串
当函数不返回任何内容时，文档字符串约定是什么? 例如: def f(x):"""打印作为输入给出的元素参数:x:任何元素返回:"""打印“您的输入是 %s" % x返回 我应该在文档字符串中的 Returns: 之后添加什么?现在什么都没有? 解决方案 您应该使用 None，因为这就是您的函数实际返回的内容: """打印作为输入给出的元素参数:x:任何元素返回:没有任何"""
..
我如何记录 :rtype: 对于返回多种可能数据类型的函数?
在 Python 文档字符串中，应该如何记录可以返回多种可能数据类型的函数的 :rtype: ? 例如，如果一个函数可以根据函数参数返回defaultdict OR dict OR list，你如何记录它? 代码示例: from collections import defaultdictdef read_state(state_file, state_file_type='defa
..