python - Python中惯用的文件级注释?
问题描述
当我需要编写关于函数的大量注释时,我会使用文档字符串。但是,我不确定 Python 中文件级注释的等价物是什么,以及模块与脚本是否不同。
使用这种风格很常见吗?
"""
file.py: module for X
Detailed information...
"""
import x
def foo(bar):
return 42
或者也许是这个?
# file.py: module for X
# More info...
import x
# ...
有什么想法吗?
解决方案
始终使用字符串,因为它实际上会填充__doc__
当前文件/模块的变量。
比较一下:
'''Hello World'''
print(__doc__)
至
# Hello World
print(__doc__)
考虑这是在一个模块中foo.py
并比较输出:
>>> import foo
>>> help(foo)
您也不需要添加“文件:...”部分,因为 python 会自动显示。
推荐阅读
- c - 查找矩阵 NxN 中的所有峰值
- c# - 更改游戏对象,当速度计的角度发生变化时
- javascript - 用于动态更改内容的引导工具提示
- reactjs - 为什么在 React 中获取用户的地理位置时出现无限循环?
- node.js - 为什么我在安装 dotenv 后删除了这么多模块?
- android - 无法达到按钮错误的声明
- c++ - 提升信号2 和 std::shared_ptr?
- django - 扩展用户对象后如何让 Django 登录 api 工作?
- python - Python中的快速函数计算Internet(TCP,UDP,ICMP,IP)校验和
- javascript - 从 mongodb 检索数据时出现错误