文档 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