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 arealand_area: int or float. This function is unit-agnostic, if you pass in values in termsof 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

Python笔记：文档注释docstrings, 让函数更易读懂相关推荐

idea html注释,IntelliJ IDEA文档注释
IntelliJ IDEA 文档注释 IntelliJ IDEA 为创建文档注释提供了方便的功能. 您的源代码中的文档注释可用于快速文档查找并通过按 Ctrl + Q 打开以进行审阅. 在 Java ...
python 帮助文档，撰写函数文档，并查看函数文档
python 帮助文档,撰写函数文档,并查看函数文档定义函数 def test(a,b):'''参数:a:整数b:整数返回值:a+b'''return a+b 运行函数 test(11,22) 33 ...
java学习笔记(四)----对象、数组作为参数传递，静态变量、静态方法的使用，内部类，使用文档注释
***对象作为参数传递*** class passparam { int x; public static void main(String[] args) { passparam obj = ...
python 帮助文档、自我解释
现在让我们以交互方式使用 Python 来开始研究.当我们从命令行启动 Python 时,就进入了 Python shell,在这里可以输入 Python 代码,而且立刻会从 Python 解释器获得 ...
Python之文档测试
0 参考文档 Sphinx--自动生成Python文档 Python之文档测试模块--doctest 1 doctest doctest是python自带的一个模块.doctest有两种使用方式:一种 ...
Python3 单行注释，多行注释，文档注释的用法
确保对模块, 函数, 方法和行内注释使用正确的风格 Python中的注释有单行注释和多行注释: 一.Python中单行注释以 # 开头,例如: # 这是一个注释 print("Hello, ...
PyCharm 设置文档注释
PyCharm 设置文档注释为了方便表示函数变量名.返回说明等说明信息,文档字符串格式设置.pycharm有内置注释模板. (这边使用的是已汉化的pycharm) 1.打开设置(setting) 2 ...
如何写Java文档注释(Java Doc Comments)
本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西本文不讨论如何使用javadoc工具自动生成文档的方法,而是主 ...
Eclipse 的快捷键以及文档注释、多行注释的快捷键一、多行注释快捷键
一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/* */注释 3.以上快捷在重 ...

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

文档 docstrings

Python笔记：文档注释docstrings, 让函数更易读懂相关推荐

最新文章

热门文章