善用docstring和annotations配合pycharm自动提示让python函数使用更便捷

最新推荐文章于 2025-10-08 07:00:00 发布

原创

最新推荐文章于 2025-10-08 07:00:00 发布 · 3.3k 阅读

CC 4.0 BY-SA版权

在使用别人定义的函数的时候，大多数时候我们不关心函数具体实现，而只想知道每个参数以及返回值的类型和说明。令人欣喜的就是pycharm已经集成了参数类型提示和说明的快捷键功能，不过这需要被调用的函数在定义的时候按照一定的格式去标注docstring和annotations。下面我们就一起来了解下这些都是啥，让我们以后自己定义的函数也能使用起来更便捷。

我是T型人小付，一位坚持终身学习的互联网从业者。喜欢我的博客欢迎在csdn上关注我，如果有问题欢迎在底下的评论区交流，谢谢。

文章目录

什么是docstring？

docstring是一个没有赋值给任何变量的string，其被用于类（class），模块（module），函数（function）或者方法（method）的定义中。一个对象的docstring出现在该对象定义的最前面，内容是对该对象的功能或者参数等的描述信息，通常用三引号表示。docstring的获取可以通过对象的__doc__属性。

下面是单行的docstring演示

def square(a):
    '''Returned argument a is squared.'''
    return a**a

print (square.__doc__)

Returned argument a is squared.

下面是多行的docstring演示

def some_function(argument1):
    """Summary or Description of the Function

    Parameters:
    argument1 (int): Description of arg1

    Returns:
    int:Returning value

   """

    return argument1

虽然说在docstring里面写什么内容都无所谓，不过为了便于pycharm的自动提示，后面我们会按照PEP规定的格式去写。

顺便一提的是python中的注释用#来表示，其也可以起到解释说明的作用，但是就没有pycharm的自动提示了。