Pycharm自动添加文件头注释和函数注释参数的方法
#代码知识 发布时间: 2026-01-12
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
代码知识SEO上一篇 : Spring Bean生命周期源码原理图解
下一篇 : python logging模块的使用详解
-
SEO外包最佳选择国内专业的白帽SEO机构,熟知搜索算法,各行业企业站优化策略!
SEO公司
-
可定制SEO优化套餐基于整站优化与品牌搜索展现,定制个性化营销推广方案!
SEO套餐
-
SEO入门教程多年积累SEO实战案例,从新手到专家,从入门到精通,海量的SEO学习资料!
SEO教程
-
SEO项目资源高质量SEO项目资源,稀缺性外链,优质文案代写,老域名提权,云主机相关配置折扣!
SEO资源
-
SEO快速建站快速搭建符合搜索引擎友好的企业网站,协助备案,域名选择,服务器配置等相关服务!
SEO建站
-
快速搜索引擎优化建议没有任何SEO机构,可以承诺搜索引擎排名的具体位置,如果有,那么请您多注意!专业的SEO机构,一般情况下只能确保目标关键词进入到首页或者前几页,如果您有相关问题,欢迎咨询!