Pycharm自动添加文件头注释和函数注释参数的方法

Pycharm自动添加文件头注释和函数注释参数的方法

1.自动添加文件头注释
设置如下：Settings->Editor->File and Code Templates->Python Script

参考模板：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
'''
@Project ：${PROJECT_NAME} 
@File ：${NAME}.py
@Author ：${USER}
@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.快速添加函数及参数注释
（1）在完成函数定义时，输入三个"""回车即可，自动添加函数注释参数。

（2）编写好注释信息后，使用函数时，可以使用如下快捷键查看函数信息：
mac：ctl+J
windows：ctrl+q