Python中添加文件注释和函数注释的操作方法

Python中添加文件注释和函数注释的操作方法

这篇文章给大家分享的是有关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中添加文件注释和函数注释的操作方法就分享到这里了,希望以上内容可以对大家有一定的帮助,让大家可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到吧!