博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Python笔记:文档注释docstrings, 让函数更易读懂
阅读量:4249 次
发布时间:2019-05-26

本文共 741 字,大约阅读时间需要 2 分钟。

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

转载地址:http://wzwei.baihongyu.com/

你可能感兴趣的文章
#####好好好好####Keras深度神经网络训练分类模型的四种方法
查看>>
[NLP自然语言处理]谷歌BERT模型深度解析
查看>>
######好好好######MSE与CE的区别?数学推导 本质理解
查看>>
######好好好,本质#####基于LSTM搭建一个文本情感分类的深度学习模型:准确率往往有95%以上
查看>>
深度学习最全优化方法总结比较(SGD,Adagrad,Adadelta,Adam,Adamax,Nadam)
查看>>
训练loss不下降原因集合
查看>>
通过GAN网络生成样本的一些想法创造数据
查看>>
###好好好好########深度模型优化性能 调参
查看>>
#######haohaohao#######对抗思想与强化学习的碰撞-SeqGAN模型原理和代码解析
查看>>
TensorFlow 模型如何对外提供服务
查看>>
将keras的h5模型转换为tensorflow的pb模型
查看>>
tensorflow+tensorflow-serving+docker+grpc模型上线部署(不需bazel编译,有代码)
查看>>
甘特图——Excel搞定
查看>>
J2EE是什么(二)
查看>>
J2EE是什么(一)
查看>>
Java学习——何为JNDI
查看>>
Java学习——传说中的13个规范
查看>>
前端页面——揭开级联查询的面纱
查看>>
前端页面——AJAX是个什么样的传输机
查看>>
前端页面——Cookie与Session有什么区别
查看>>