Python新手求教:如何在终端或交互环境打印.py文件中的文档字符串?
如何查看Python函数的文档字符串
嘿,作为Python新手能关注到文档字符串的用法真的挺不错的!针对你写的foo()函数,有几种简单的方法能在终端或交互会话里打印出它的文档字符串:
方法一:使用help()函数(最推荐,格式更友好)
这也是你提到的方式,具体操作步骤:
- 打开终端,输入
python或python3进入Python交互会话 - 先导入你的模块:
import foo - 然后调用help查看函数文档:
help(foo.foo)
这样会输出格式化的文档内容,清晰展示函数名和你写的foo documentation
方法二:直接访问__doc__属性(精准获取文档字符串内容)
如果你只想直接打印出那行文档文本,可以这么做:
- 同样先进入交互会话并导入模块:
import foo - 执行打印命令:
print(foo.foo.__doc__)
这个会直接输出你定义的foo documentation字符串
额外小技巧:在脚本里直接输出
要是你想运行脚本的时候就看到文档,也可以在foo.py里加上这行:
def foo(): """ foo documentation """ # some code here if __name__ == "__main__": print(foo.__doc__)
然后在终端运行python foo.py,就能直接看到文档内容啦!
内容的提问来源于stack exchange,提问作者kaifi




