四、Python函数 之 1、为函数提供说明文档并查看函数文档

1、为函数提供说明文档并查看函数文档

• 为函数提供说明文档

  def test(parm1,parm2):
      '''
      test 函数的说明
      parm1 - 代表...
      parm2 - 代表...
      return - 代表...
      '''
      pass
  

• 查看函数文档

  • 方法1

    print(test.__doc__)
    

        test 函数的说明
        parm1 - 代表...
        parm2 - 代表...
        return - 代表...
    

  • 方法2

    print(help(test))
    

    Help on function test in module __main__:
    
    test(parm1, parm2)
        test 函数的说明
        parm1 - 代表...
        parm2 - 代表...
        return - 代表...