在Python 2.x中创建信息性注释的Pythonic方法是什么?

1 python comments

为了进一步说明,C#有'///'指令,它调用超级秘密风格的注释,允许你在intellisense中建立好的注释.Java有'@'指令,允许你有很好的评论.

Python有这样的东西吗?我希望这个问题很清楚,谢谢!

Aar*_*lla 7

它们在Python中称为docstrings.请参阅文档.

一个很好的功能是代码示例(在此解释).他们允许将代码放入文档中:

>>> 1 + 1
2
>>>
Run Code Online (Sandbox Code Playgroud)

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