Jac*_*ing 16 python comments module conventions
我的理解是,模块文档字符串应该只提供模块所做的一般描述,而作者和版本等细节只应包含在模块的注释中.
但是,我在评论和文档字符串中看到了以下内容:
__author__ = "..."
__version__ = "..."
__date__ = "..."
放置这些物品的正确位置在哪里？__[name]__在模块顶部列出的其他常见变量是什么？
它们仅仅是惯例,尽管是广泛使用的惯例.请参阅一组Python元数据要求的此描述.
__version__在Python样式指南中提到.
关于docstrings,有一个PEP只为你!
模块的docstring通常应列出模块导出的类,异常和函数(以及任何其他对象),每个对应的摘要.(这些摘要通常提供的细节少于对象文档字符串中的摘要行.)包的docstring(即包的init .py模块的docstring )也应列出包导出的模块和子包.
| 归档时间： |
|
| 查看次数： |
4611 次 |
| 最近记录： |