问题标签 [docstring]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python - 与 Python 类属性一起使用的文档字符串?
我在下面定义了一个类,它有一个名为“prop”的类属性,我希望打印出文档字符串“这是一个属性注释”。当前行为执行属性的 getter 并打印“getter”。
有没有办法设置类及其元类,以便我可以输入“帮助(MyClass.prop)”并获取文档字符串?
python - 根据 PEP257 自动检查文档字符串样式的工具
pep8 之类的工具可以检查源代码样式,但它们不会检查文档字符串是否根据pep257,pep287 来自atted。有这样的工具吗?
更新
我决定自己实现这样一个静态分析工具,见:
python - 分配要由帮助()打印的默认值的pythonic方法是什么?
我编写了以下脚本来加载和分配help()
搜索字段的默认值:
有没有更蟒蛇的方式来做到这一点?这甚至是个好主意吗?
help()
即使没有提供正确的元数据,现在也可以打印出来。
也感谢对代码的任何评论。
python - 如何从函数本身内部打印python函数的Docstring?
我想从函数本身内部打印 python 函数的文档字符串。例如。
目前,我在my_function
定义后直接执行此操作。
但宁愿让函数自己做这件事。
我曾尝试在 my_function 内部调用print self.__doc__
print self.my_function.__doc__
and print this.__doc__
,但这不起作用。
python - 在 emacs Python 模式下,如何为文档字符串和代码设置不同的自动填充宽度?
我想将代码部分的自动填充设置为 79 列,将文档字符串设置为 72 列,以获得自动 PEP8 合规性。对于 Lisp 模式(emacs-lisp-docstring-fill-column),似乎有一个选项可以执行此操作,但对于 Python 则没有。
是否有增强的 python-mode.el 在某个地方包含这个?
python - 在 iPython 中查看 reStructuredText (Sphinx) 文档字符串?
当您键入以下内容时,有没有办法让 IPython 完全呈现 reStructuredText(对于 Sphinx)文档字符串:
或者:
当 IPython 显示原始标记时,我发现尝试阅读 IPython 中的帮助文档会让人分心。reST 非常适合 Sphinx 文档,但确实会混淆简单的帮助查找。我不能一个人在这个上......?
谷歌在这方面没有任何帮助。
python - 属性文档字符串
考虑代码:
我想将文档字符串添加到所有属性。所以,我可以做类似的事情(对于文件属性):
但是,为每个属性编写 getter、setter 和 deleter 方法很繁琐。事实上,这些方法(如上所示)执行默认工作。
有没有一种简单的方法可以只将文档字符串添加到属性中?
javascript - 从 javascript 解析 python 文档字符串
我需要从几个 python 文件中解析 docstring,我需要用 Javascript 来做这件事。
我找不到任何参考,有什么想法吗?
编辑:我正在使用 Titanium SDK 和 jquery。PyDoc 不是我正在寻找的解决方案,因为我不想在 javascript 和 python 源代码的中间包含一些进程。
编辑 2:已解决 - Titanium 可以同时使用 python 和 javascript,所以我可以使用 python 来解析 python 文件中的文档字符串。