【问题标题】:How do you add function guides to python when writing a module?编写模块时如何向python添加功能指南?
【发布时间】:2019-04-22 11:56:06
【问题描述】:

我最近在写一个有很多功能的python模块,我想知道是否可以,如果可以,我该如何实现这些功能指南,如下图所示。提前致谢!

【问题讨论】:

  • 只是要注意显示工具提示(在您的屏幕截图中),这是外壳的一个功能。如果您在另一个程序中编写代码,您可能不会得到这些提示。

标签: python python-3.x function functional-programming python-idle


【解决方案1】:

这些是function docstrings,要在写函数的时候定义它们,只需在函数开头添加一个多行字符串

def function():
    '''This function does nothing'''
    pass

要访问文档字符串,请使用 function.__doc__help(function)

【讨论】:

  • 我的函数中有这些文档字符串,尽管打开括号时它们都没有显示(请参阅原始问题中的图片)
  • @Jake 正如 Burhan Khalid 所说,工具提示是您的编辑器或 IDE 的功能。但是,我确实在 IDLE image 上获得了工具提示
猜你喜欢
  • 2016-06-24
  • 1970-01-01
  • 1970-01-01
  • 2010-09-10
  • 1970-01-01
  • 2021-12-16
  • 2012-06-21
  • 2016-11-25
相关资源
最近更新 更多