首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Python】函数 ⑤ ( 函数说明文档 | 函数说明文档内容建议 | 代码示例 )

一、函数说明文档 1、函数说明文档简介 函数说明文档 就是 通过 注释 对 函数的作用进行解释说明 ; 函数说明文档 用法 : 在 函数定义 后 , 函数体的第一行位置 , 输入六个双引号 , 此时光标会自动停留在第三个双引号之后..., 在 光标停留在 第三个 双引号 之后 闪烁的状态下 , 敲击回车键 , 会自动生成如下 函数说明文档 的注释格式 , 其中包括 :param 形参: 参数说明格式 , :return: 返回值说明格式...; 注意 : 函数的解释文字 , 要与 第一个形参说明所在行 , 两行之间间隔 1 行 ; 2、函数说明文档内容建议 Python 函数说明文档 建议包含如下内容 : 函数功能描述 : 对函数的功能...代码示例 : """ 函数说明文档 代码示例 """ def add(a, b): """ 函数作用 :param a: 参数一形参说明 :param b: 参数二形参说明...:return: 返回值说明 """ return a + b sum = add(1, 2) 此时 , 如果将鼠标放在 add 函数上 , 在弹出的提示框中 , 会显示 函数说明文档

17810
您找到你想要的搜索结果了吗?
是的
没有找到

ReStructuredText 文档编写全攻略编写文档说明

编写文档说明python 的人一定会注意到很多python 文档都很相似,不管是整体风格还是结构组织方式都很类似。...比如: scrapy 文档 scrapy.png 再比如: flask 文档 flask.png 再再比如: reStructuredText 中文文档 rst.png 再再再比如: Python-web-guide...将 rst 格式的文件转换成 html 等格式的文件,方便托管在服务器上,进行访问,依赖的工具有:sphinx sphinx 介绍 sphinx 是一个基于python文档生成工具,许多 python...gitbook init 自动创建文件夹和文件 编写相应的文件 gitbook serve 编译和预览书籍内容和结构 编写rst文档的流程 python sphinx 编写文档 组织文档结构 make...安装python 前提需要 python 环境 2. 安装sphinx pip install sphinx 3. 创建文档项目 sphinx_quickstart 几乎是一路默认下来。看操作提示。

5.3K31

python文档

对象中可用属性的列表 文档字符串doc 附加在对象文件中的文档 标准手册 正式的语言和库的说明 网站...在线教程,例子 书籍 商业参考书籍 注释 代码编写的最基本的方式,文档字符串用于较大功能的文档 而# 用于较小功能的文档 dir函数 #抓取对象内可用的所有属性列表的简单方式...,这类注释是写成字符串,放在模块文件,函数以及语句的顶端 #在可执行代码执行前,会自动封装这个字符串,也就是文档字符串,使他成为doc 属性 #内置文档字符串可以用__doc_来查看 import sys...#help函数 启动pydoc来查看文档,如help函数和PyDocGUI、HTML接口 print(help(int)) ......常见编写代码陷阱 别忘了复合语句末尾输入':' 要确定顶层程序代码从第1行开始 空白行在交互模式下是告诉交互模式命令行完成复合语句 缩进要一致,尽量使用统一缩进,统一制表符或者四个空格 不要在python

1.8K20
领券