Python笔记:文档注释docstrings, 让函数更易读懂

文档 docstrings

  • 文档字符串是一种注释,用于解释函数的作用以及使用方式,文档字符串用三个引号引起来:

      def population_density(population, land_area):
        """Calculate the population density of an area. """
        return population / land_area
    
  • 一行文档字符串完全可接受, 可以在一行摘要后面添加更多信息。我们还可以对函数的参数进行了解释,描述每个参数的作用和类型。我们经常还会对函数输出进行说明:

      def population_density(population, land_area):
        """Calculate the population density of an area.
    
        INPUT:
        population: int. The population of that area
        land_area: int or float. This function is unit-agnostic, if you pass in values in terms
        of square km or square miles the function will return a density in those units.
    
        OUTPUT: 
        population_density: population / land_area. The population density of a particular area.
        """
        return population / land_area
    
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Wang's Blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值