Python
Java
PHP
IOS
Android
Nodejs
JavaScript
Html5
Windows
Ubuntu
Linux
我可以使用 VIM 查看 Python 中函数的文档字符串吗?
在 VIM 中编写 Python 时 有什么方法可以查看函数的文档字符串吗 例如 def MyFunction spam A function that foobars the spam returns eggs return foobar
python
Vim
docstring
Python 文档的 reStructuredText 有真正的替代品吗? [关闭]
Closed 这个问题正在寻求书籍 工具 软件库等的推荐 不满足堆栈溢出指南 help closed questions 目前不接受答案 我很快就要开始一个开源 Python 项目 并且我试图提前决定如何编写我的文档字符串 显而易见的答案是
python
pythonsphinx
reStructuredText
docstring
对于类和 __init__ 文档字符串中应记录的内容是否达成共识?
我没有找到任何关于课堂上应记录的内容的最佳实践 并且 init 文档字符串 有时我发现构造函数参数已经记录在类文档字符串中 有时在 init 文档字符串 我更喜欢在类文档字符串中描述构造 因为这是创建新实例时所调用的 但是应该在文件中记录什
python
docstring
codedocumentation
在 Python 中继承方法的文档字符串
我有一个带有文档字符串的面向对象层次结构 需要与代码本身一样多的维护 例如 class Swallow object def airspeed self Returns the airspeed unladen raise NotImple
python
OOP
inheritance
docstring
templatemethodpattern
Python-Sphinx:从超类“继承”方法文档
Edit 截至目前 Sphinx 1 4 9 似乎没有办法告诉 Sphinx 做我想做的事情 参见issue https github com sphinx doc sphinx issues 3140在 GitHub 上 这接受的答案 h
python
inheritance
pythonsphinx
docstring
如何阻止 PyCharm 填充文档字符串?
如果我使用三引号将文档字符串添加到方法中 只要我在三引号后键入空格 PyCharm 就会使用该方法采用的参数和返回值填充文档字符串 如下所示 def fill blank self direction param direction ret
python
intellijidea
pycharm
docstring
单个模块/函数等有超过 1 个文档字符串吗?
我正在使用 python 3 1 是否可以为单个模块或函数创建超过 1 个文档字符串 我正在创建一个程序 并且打算拥有多个文档字符串 每个文档字符串都有一个类别 我打算向其他人提供该程序 以便他们可以使用它 并且为了让程序员和非程序员都轻松
python
docstring
在 python 中为 lambda 函数编写文档字符串的最佳方法是什么?
我通常使用带有 的多行文档字符串来注释我的函数 如下所述 https www python org dev peps pep 0257 https www python org dev peps pep 0257 def func1 x T
python
Lambda
docstring
嵌套文档字符串的 Doctest
假设我有以下代码 def foo s A dummy function foo For example gt gt gt a This is a test string line 1 This is a test string line 2
python
doctest
docstring
NumPy 如何将文档字符串处理为参数的 sphinx 文档?
我想使用 sphinx 构建我们的文档 并获得与 NumPy 文档相同的参数格式 https github com numpy numpy blob master doc HOWTO DOCUMENT rst txt https githu
NumPy
pythonsphinx
docstring
让 Sphinx 替换文档字符串文本
我正在 Sphinx 中记录类似于以下内容的代码 class ParentClass object def init self pass def generic fun self Call this function using run P
python
pythonsphinx
substitution
docstring
描述符的 Python 文档字符串
我使用描述符来定义接口类的寄存器 class Register object def init self address docstring instance docstring self address address self doc
python
python27
ipython
descriptor
docstring
如何使用 Sphinx 标记引用记录的 Python 函数参数?
我想在 Python 文档字符串中的其他位置引用先前记录的函数参数 考虑以下 诚然完全是人为的 示例 def foo bar Perform foo action param bar The bar parameter def nested
python
pythonsphinx
docstring
从 Python 文档字符串自动生成 GitHub Wiki 文档
标题说明了一切 我的想法是为我的所有模块 类和函数提供文档字符串 并以某种方式通过 github wiki 很好地导航文档 此外 该文档应与最新代码同步 这意味着它应在推送时更新 重新生成 那可能吗 只需通过管道传输生成的输出docstri
python
GitHub
markdown
wiki
docstring
在 Python 文档字符串中引用参数
我使用 Sphinx 和自动文档功能来确保我们的项目中有良好的文档 所以我很熟悉信息字段列表 http sphinx doc org domains html info field lists我熟悉使用交叉引用 http sphinx do
python
pythonsphinx
docstring
链接到类的 PyCharm 文档字符串
IntelliJ IDEA 允许链接到 Java 文档注释中的其他方法 这允许我将光标移动到符号上并使用键盘快捷键跳转到定义 以及在按住 ctrl 的同时将鼠标悬停在可单击的符号下方显示下划线 例如 This is a link to a
python
pycharm
docstring
函数名 + tab 在 IPython 中不返回文档字符串
在IPython中 我习惯这样写 功能 然后点击一个选项卡 获取文档字符串的内容和命名参数的列表 然而 自从我安装了 IPython 2 0 后 它就停止工作了 有解释或已知的修复吗 哦 现在是捷径shift tab
ipython
jupyternotebook
docstring
tabcompletion
如何在 Sphinx 处理的文档字符串中表达单个参数或返回值的多种类型?
有时 Python 中的函数可能接受灵活类型的参数 或者它可能返回一个灵活类型的值 现在我不记得这样的函数的一个很好的例子 因此我用下面的玩具示例来演示这样的函数可能是什么样子 我想知道如何使用 Sphinx 文档符号为此类函数编写文档字符
python
pythonsphinx
docstring
sphinxnapoleon
阅读不使用 automodule 的文档
我已经为我的项目编写了一些文档 在 Python 文档字符串中 并在我的本地计算机上使用 Sphinx 测试了所有内容 一切正常 所有导入工作正常等等 所以我在阅读文档上设置了一个自定义环境 Python 3 numpydoc和我的图书馆
python
pythonsphinx
docstring
ReadTheDocs
Python 文档字符串模板化
为什么动态格式化文档字符串不起作用 是否有可接受的解决方法来执行此操作在函数定义时 gt gt gt DEFAULT BAR moe s tavern gt gt gt def foo bar DEFAULT BAR hello this
python
docstring
1
2
»