当前位置:首页 >> 脚本专栏

Python 添加文件注释和函数注释操作

1、文件添加方式:

pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者、日期等必要信息,使用比较方便,配置十分简单。

#!C:\pythonCode
# -*- coding: utf-8 -*-
# @Time : ${DATE} ${TIME}
# @Author : hlx
# @File : ${NAME}.py
# @Software: ${PRODUCT_NAME}

Python 添加文件注释和函数注释操作

2、自动生成函数注释,包括参数和返回值。使用方法,函数定义时,直接输入三个双引号后回车。

Python 添加文件注释和函数注释操作

也可以将光标放在方法上,会弹出一个小灯,选择第一个就好了。

Python 添加文件注释和函数注释操作

显示如下:

Python 添加文件注释和函数注释操作

补充知识:Python中使用PyCharm为函数及参数增加注释

在函数名中键入数遍光标,左上角亮起小灯泡,点击小灯泡

Python 添加文件注释和函数注释操作

选中第二行内容

Python 添加文件注释和函数注释操作

在"""后添加函数注释,以及参数注释

然后再引用函数时,选中函数,Ctrl q 即可显示函数以及参数的注释了

Python 添加文件注释和函数注释操作

以上这篇Python 添加文件注释和函数注释操作就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持。