gpt4 book ai didi

python - PyCharm/IntelliJ 对 Python 文档字符串使用什么样式?

转载 作者:行者123 更新时间:2023-11-28 22:24:30 25 4
gpt4 key购买 nike

我正在尝试了解有关创建文档字符串的“解决方案生态系统”,然后使用 PyCharm/IntelliJ 生成一些不错的引用文档。

我习惯了 Google 风格的文档字符串,但对 PyCharm 的默认文档字符串框架格式/样式感到困惑:

"""
:param <paramname>: blah blah
:return None
"""

这是什么风格,它使用什么引用文档生成器?哪里有风格指南?

最佳答案

这些是 Sphinx样式文档字符串。

Python 对文档字符串有一些强烈的看法,请参阅 PEP257 .

这里是 Python 中所有文档字符串类型的完整描述:What is the standard Python docstring format?

关于python - PyCharm/IntelliJ 对 Python 文档字符串使用什么样式?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/46347038/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com