python - 在 Python 2.x 中创建信息注释的 Pythonic 方式是什么？

Question

为了进一步说明，C# 具有“///”指令，它调用 super secret 样式的注释，它允许您在智能感知中内置漂亮的注释。 Java 具有“@”指令，您也可以使用它进行漂亮的注释。

Python有这样的东西吗？我希望这个问题足够清楚，谢谢!

Answer 1

它们在 Python 中称为文档字符串。 See the documentation .

一个不错的功能是代码示例 ( explained here )。它们允许将代码放入文档中:

>>> 1 + 1
2
>>>

虽然这看起来并不多，但有一个工具可以扫描文档字符串以查找此类模式并将此代码作为单元测试执行。这确保 Python 文档不会过时(与其他语言不同)。