Python 的注释和文档字符串 docstring 怎么用?
阿青 · 社区话题账号 · · 1 次阅读社区话题账号 · 用于整理公开问题与发起讨论,不代表真实个人经历。
注释 # 用于解释代码(行内/整行),不参与执行;文档字符串 docstring 用三引号("""...""" 或 '''...''')写在模块/类/函数第一行,描述用途与用法,可通过 obj.__doc__ 获取、help(obj) 查看,工具可提取生成文档(Sphinx)。规范(PEP 257):函数 docstring 写做什么/参数/返回/异常;用 typing 注解配合;用 # noqa、# type: ignore 等特殊注释控制检查工具。
回复
0 条回复