如何设置Pycharm自动为文件和函数添加注释？

本文共计640个文字，预计阅读时间需要3分钟。

PyCharm是学习Python必备的编辑器，关于它的使用，之前已写过几篇文章。今天再给家长介绍两个PyCharm的小技巧，希望对大家有所帮助。

1. 自动添加文件头注释 + 文件头模板设置路径

Pycharm应该是学python必用的编辑器了，关于它的使用之前已经写过几篇文章，今天再给大家继续介绍两个pycharm的小技巧，希望对大家有用。

1.自动添加文件头注释

文件头模板设置路径

Settings->Editor->File and Code Templates->Python Script

在右侧箭头区域添加模板代码。

参考模板：

#!/usr/bin/env python # -*- coding: UTF-8 -*- ''' @Project ：${PROJECT_NAME} @File ：${NAME}.py @Author ：吾非同 @Date ：${DATE} ${TIME} '''

然后在pycharm中，新建python文件，自动添加文件头注释，效果如下：

模板常用内置变量

格式 作用效果 ${PROJECT_NAME} 项目名 ${PRODUCT_NAME} 集成开发环境 ${NAME} 文件名 ${USER} 用户名（指登录电脑的那个用户名） ${DATE} 当前系统的年月日 ${TIME} 当前系统的时分秒 ${YEAR} 当前年份 ${MONTH} 当前月份（形式：07） ${MONTH_NAME_SHORT} 当前月份（形式：7月） ${MONTH_NAME_FULL} 当前月份（形式：七月） ${DAY} 当天 ${HOUR} 当前小时 ${MINUTE} 当前分钟 ${SECOND} 当前秒钟

大家可以根据自己的喜好，设置一个专属的文件注释版本。

2.快速添加函数及参数注释

在完成函数定义时，输入三个"""回车即可，自动添加函数注释参数。

编写好注释信息后，使用函数时，可以使用如下快捷键查看函数信息：

mac：ctl+J

windows：ctrl+q

到此这篇关于Pycharm自动添加文件头注释和函数注释参数的方法的文章就介绍到这了,更多相关Pycharm自动添加注释 内容请搜索易盾网络以前的文章或继续浏览下面的相关文章希望大家以后多多支持易盾网络！