我正在尝试了解有关创建文档字符串的“解决方案生态系统”,然后使用 PyCharm/IntelliJ 生成一些不错的参考文档。
我习惯了 Google 风格的文档字符串,但对 PyCharm 的默认文档字符串骨架格式/样式感到困惑:
"""
:param <paramname>: blah blah
:return None
"""
这是什么风格?它可以与哪些参考文档生成器配合使用? 有什么风格指南吗?
这些是 Sphinx 风格的文档字符串。
Python 对文档字符串有一些强烈的看法,请参阅 PEP257。
以下是 Python 中所有文档字符串类型的完整描述:标准 Python 文档字符串格式是什么?
[图片][1]
我在这里找到了这张图片:
https://www.jetbrains.com/help/pycharm/creating-documentation-comments.html
[1]:https://i.sstatic.net/fzHtPi6t.png
它提到了*斜体*、**粗体**、“等宽”、“链接