代码之家 › 专栏 › 技术社区 › Jace Browning

Python模块注释有约定吗?

conventions comments module python

Jace Browning · 技术社区 · 14 年前

我的理解是,模块docstring应该只提供模块功能的一般描述,而作者和版本等细节应该只包含在模块的注释中。

和文档字符串:

__author__ = "..."
__version__ = "..."
__date__ = "..."

这样的物品放在哪里才是正确的位置?还有什么 __[name]__ 变量通常列在模块的顶部?

3 回复 | 直到 11 年前

Katriel 14 年前

它们仅仅是惯例,尽管使用得相当广泛。看到了吗 this description 一组Python元数据需求。

模块的docstring应该一般列出类别、例外情况和功能(以及任何其他对象) 在对象的 docstring.)的docstring 包(即 初始化 .py模块)应同时列出模块和子包由包导出。

Bruno 14 年前

Katriel 14 年前

我建议你不要担心 __author__ , __version__ 这些属性无论如何都是由任何像样的版本控制系统来处理的。仅当您需要在生产系统上拥有这些信息时才添加它们,因为源代码已经从版本控制系统中导出。

推荐文章

spicy-lemonade · 在rust中,为什么像rand这样的模块不包括子模块?

2 年前

beginnersluke · Python模块函数使用全局env中的变量

2 年前

Joonatan · 在python/jupyter上导入模块

2 年前

ZeinabBanayazdi · 虽然我只写了打印属性“a”的代码,但为什么代码要打印“测试消息”

2 年前

Jambla · 我如何使用一个地形模块的输出作为另一个地形模块的输入?

2 年前

Stanford Martinez · 获取错误:AttributeError:模块“nmap”没有属性“PortScanner”

2 年前

Ciprian · 未找到Angular 6 setTimeout模块:错误:无法解析“timers”

6 年前

Lafdoma · 如何在Apache2中安装libevent扩展

6 年前

blackhelmet34 · 无法在hassio上以节点红色安装任何模块(节点)

6 年前

Mikhail Genkin · AttributeError:模块“numpy”没有属性“matlib”[重复]

6 年前