Python学习记录文档字符串

云风星月皆待卿

于 2022-07-24 08:13:53 发布

阅读量186

点赞数

CC 4.0 BY-SA版权

分类专栏： Python 文章标签：学习 python

本文链接：https://blog.youkuaiyun.com/Code_peasant/article/details/125955552

Python 专栏收录该内容

38 篇文章

订阅专栏

本文介绍了Python中函数的使用，包括形参和实参的概念及其在函数`printMax`中的应用。此外，强调了文档字符串在提高代码可读性方面的重要性，它可以在函数定义时提供函数功能的说明。示例中展示了如何创建和使用文档字符串，以及如何通过`help()`函数查看。最后，通过`play`函数展示了文档字符串的实践。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

2022.07.20 DAY20

1. 函数的用法和底层分析

1. 形参和实参

# 形参和实参
def printMax(a, b):
    """ 实现两个数的比较，并返回较大的值 """
    if a > b:
        print(a, '较大值')
    elif a < b:
        print(b, '较大值')
    else:
        print("a, b一样大")


if __name__ == '__main__':
    printMax(10, 20)
    printMax(30, 5)

2. 文档字符串

程序的可读性最重要，一般建议在函数体开始的部分附上函数兴义说明，这就是文档字符串，也有人称为函数的注释。
通过三个单引号或者三个双引号类实现，中间可以加入多行文字进行说明。

调用help(函数名,doc)可以打印输出函数的文档字符串。

  def play():
      """ 快来找我玩啊 """
      print("快来找我玩啊!!!")


  if __name__ == '__main__':
      help(play.__doc__)
      play()