PyCharm 配置自动文件头注释与函数文档字符串生成

PyCharm 自动文件头注释配置

1、文件添加方式：

PyCharm 内置了在新建文件时自动生成文件头注释的功能，可自动填充运行环境、作者、日期等必要信息，配置简单且使用便捷。

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

快速生成函数文档字符串

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

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

显示如下：

通过灯泡图标完善函数注释

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

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

选中第二行内容

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

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

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