一、函数说明文档
1、函数说明文档简介
函数说明文档 就是 通过 注释 对 函数的作用进行解释说明 ;
函数说明文档 用法 :
在 函数定义 后 , 函数体的第一行位置 , 输入六个双引号 , 此时光标会自动停留在第三个双引号之后...,
在 光标停留在 第三个 双引号 之后 闪烁的状态下 , 敲击回车键 , 会自动生成如下 函数说明文档 的注释格式 , 其中包括
:param 形参: 参数说明格式 ,
:return: 返回值说明格式...进行简单或详细介绍 , 如 : 输入的形式参数 和 返回值 之间的关系 ;
函数参数列表 : 介绍函数参数列表 , 包括函数接受的参数及其类型、默认值等信息 ;
函数返回值 : 函数返回值 介绍 ;...: 参数一形参说明
:param b: 参数二形参说明
:return: 返回值说明
"""
return a + b
sum = add(1, 2)
此时 , 如果将鼠标放在...add 函数上 , 在弹出的提示框中 , 会显示 函数说明文档 的内容 ;