2回答
python docstring中的标签@ivar @param和@type是什么？
python、documentation、javadoc
ampoule项目在docstring中使用了一些标记，比如javadoc。例如，在第86行中： """
浏览 2提问于2008-12-18得票数 16
回答已采纳
1回答
根据PEP标准，Python文档字符串的“`current`”正确格式是什么？
python、python-3.x、docstring
我一直在网络上寻找Python的当前标准，并且在不同的场景中遇到了不同的答案。我应该使用的当前最受接受和最广泛的docstring格式是什么？到目前为止，我发现了这些：狮身人面像格式(2)：:py:param type name: description
NumPy格式：Param
浏览 5提问于2022-12-02得票数 0
回答已采纳
2回答
哪个更有效: Python文档字符串还是类型提示？
python、python-3.x、type-hinting、docstring、python-jedi
我想在我的代码中添加一些对自动完成的支持。这可以通过使用函数docstring或键入提示(或两者兼用)来完成。def function_with_types_in_docstring(param1, param2): :type param<
浏览 5提问于2017-06-06得票数 24
回答已采纳
2回答
函数体中的多行字符串无法在VS代码中生成具有autoDocstring扩展的Python
python、visual-studio-code、docstring
要用Python生成文档，我必须使用特定的docstring格式。def func(param1, param2, param3): """_summary_:param</
浏览 10提问于2022-02-21得票数 2
回答已采纳
2回答
PythonPEP-8返回值格式
python、documentation、pep8
我不确定我是否看到了这方面的具体答案，但我有一个关于python文档字符串返回值的样式约定的问题。考虑一下这样的功能： output = 2*ex在PyCharm中，如果我为该函数创建了一个docstring，则如下所示： """
浏览 5提问于2017-11-04得票数 2
3回答
如何在PyCharm中自动生成docstring中字段的类型？
python、pycharm、docstring
当我创建带有参数的函数时，PyCharm为我提供了用:param param_name:字段创建docstring的功能，这非常好。但我也需要添加:type param_name:。因此，从这一点来看： return bar + xyzdef
浏览 2提问于2015-06-26得票数 28
1回答
Python文档字符串被破坏，首先需要参数。
python、python-sphinx、docstring、autodoc
使用python的docstring与Sphinx Autodoc/拿破仑结合使用时，我遇到了一个奇怪的错误：:type chronic:当我将文本放在参数后面(与pythons构建的文档字符串生成格式相反)时，它可以工作：:param chro
浏览 5提问于2022-10-08得票数 0
回答已采纳
1回答
如何记录/docstring一个参数/返回类型为动态的函数？
python、docstring
如何指示/document/docstring是pickle.dump()接收的参数类型，还是pickle.load()返回的值的类型？以下是Google Style Python Docsting的一个示例。如你所见，一个普通函数的参数类型和返回类型都是静态的，并且有明确的文档记录： def function_with_types_in_docstring(param<
浏览 15提问于2021-08-11得票数 0
2回答
Sphinx不显示泛型类的类实例化参数(即参数类型)。
python、python-sphinx、autodoc、python-typing
泛型Python类(即参数类型)的Sphinx文档不显示初始化参数。期望输出：class GenericClass(value: T)Python源代码(class_test.py)
#:TypeVar("T"): Type variable serving as a parameter for generic typesbysource'
浏览 6提问于2020-09-18得票数 3
回答已采纳
2回答
重复param文本
python、docstring
在Python模块(设计用于IPython笔记本中技术较低的用户)中，我有以下几种功能：load_that(dt, that_filter)dt param的docstring对于每个函数都是相同的：
:param dt: date, date tuple, or datetime tuple.date type<
浏览 5提问于2015-09-11得票数 0
回答已采纳
1回答
使用docstring‘HTTP’和‘`args`’节来指定HTTP状态和URL参数合适吗？
python、documentation、coding-standards
目前，我正在编写文档并使用Pydoc将docstring添加到代码库中。作为一个web框架，龙卷风应用程序的结构包括每个API端点都有一个处理程序类，并且每个处理程序类对于端点应该处理的每个HTTP请求方法都有一个单独的Python方法。这些Python方法总是具有get(self)、post(self)、put(self)等表单的签名，并且它们本身不带任何参数。但我不确定这是否是常见的(或最好的)
浏览 0提问于2017-02-07得票数 0
1回答
修改了vscode中的sphinx样式文档字符串
python-3.x、pycharm、vscode-settings、docstring
总之，我在VSCode和Pycharm中都尝试了这一点。本质上，我想修改自动生成的文档字符串的样式。在VSCode中，我使用了扩展- "Python Docstring Generator“。当前将其设置为sphinx会生成如下内容： """ :type a: :type</
浏览 12提问于2020-05-12得票数 0
1回答
PyCharm和reStructuredText (狮身人面像)文档弹出
python、pycharm、python-sphinx、epydoc
让我们想象一下，我希望看到PyCharm 4.5 Community中的一个简单方法的docstring弹出(也在5.0中尝试过)。我用两种epytext语法编写了这些文档字符串(Epydoc生成器自2008年以来就不受支持，只适用于Python2)和reStructuredText语法(由狮身人面像积极支持的生成器使用，用于官方python尝试用PyCharm设置来处理这个问题，阅读PyCharm会有所帮助，通过P
浏览 6提问于2016-08-30得票数 3
回答已采纳
2回答
Python:如何将doxygen注释添加到带有装饰器的函数中？
python、decorator、doxygen、python-decorators
我必须在哪里插入doxygen注释？： # @brief Text def foo(self):或者像这样： ## def foo(self):
浏览 3提问于2016-05-10得票数 2
回答已采纳
1回答
Python模块参考与Sphinx文档
python、python-sphinx
:param message_identifier: Message identifier (defined in the :py:module:`MyModule.constants` file).:type message_identifier: int """当我用sphinx-build编译它时，我有以下错误：
..
浏览 1提问于2015-08-07得票数 11
回答已采纳
2回答
Python:表示返回类型和参数类型的标准方法
python、python-2.7、types、return-type、docstring
是否有标准的Pythonic方法来表示函数的参数类型和返回类型？我正在寻找一种符号，即：
"""replaces template place holderwith values
:type timestamp: str or unicode
浏览 1提问于2014-07-27得票数 2
回答已采纳
1回答
我花了很长时间才弄明白这件事，我觉得很困扰我，所以我想我应该把这个贴在这里，以防有人遇到同样的问题……问题
问题的核心是，有时候，在处理返回对象的PyTest中的补丁时，当您在PyCharm测试中使用这些补丁时，不会得到自动完成提示。如果在编写测试时有大量方法要引用的对象，这会给测试编写过程增加许多开销和不便。，在我使用夹具的测试代码中，自动完成将不能正常工作。(This DOES o
浏览 3提问于2016-10-07得票数 16
5回答
python有与javascript等效的函数注释吗？
javascript、python、node.js、python-3.x、docstring
在Javascript中，编码器可以使用@param和{string}选项注释如下所示的函数。Python有一个docstring，但是读取https://www.python.org/dev/peps/pep-0257/文档字符串约定时，我看不到相当于js的内容。下面是一个注释过的JS函数的示例： * generate a random
浏览 6提问于2019-11-05得票数 2
回答已采纳
4回答
自动从epydoc的文档字符串格式切换到sphinx文档字符串格式？
python、converter、python-sphinx、docstring、epydoc
我有一个使用epydoc进行文档记录的项目。现在我正试着换成斯芬克斯。我为epydocs设置了所有文档字符串的格式，使用B{}、L{}等进行加粗、链接等操作，并使用@param、@return、@raise等来解释输入、输出、异常等。所以现在我切换到了sphinx，它失去了所有这些特性。有没有一种自动的方法将epydocs格式的文档字符串转换为sphinx格式的文档字符串？
浏览 3提问于2012-04-04得票数 10
回答已采纳
1回答
在Python模块中，这些元素应该是什么顺序？
python
当出现时，这些元素在Python模块中声明的顺序是什么？
如果最后声明，docstring将在调用help(module)中工作吗？
浏览 2提问于2020-01-15得票数 4
回答已采纳
云服务器
对象存储
ICP备案
云点播
实时音视频
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号