参考
https://blog.csdn.net/mouday/article/details/80515308
https://blog.csdn.net/dkjkls/article/details/88933950
自定义 文件模板
pycharm文件模板
入口：
Preferences --> Editor ---> File and Code Templates --> Python Script
贴入自定义文件头
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
"""
@File : ${NAME}.py
@Contact : [email protected]
@Author : name
@Modify Time @Version @Desciption
------------ -------- -----------
${DATE} ${TIME} 1.0 None
"""
变量 NAME DATE TIME为pycharm编辑器自带
新创建文件后会自动添加以上信息
其它变量参考：
${PROJECT_NAME} - 当前的项目名
${NAME} - 在文件创建过程中，新文件对话框的命名
${USER} - 当前的登录用户
${DATE} - 现在的系统日期
${TIME} - 现在的系统时间
${YEAR} - 当前年份
${MONTH} - 当前月份
${DAY} - 当前月份中的第几日
${HOUR} - 现在的小时
${MINUTE} - 现在的分钟
${PRODUCT_NAME} - IDE创建文件的名称
${MONTH_NAME_SHORT} - 月份的前三个字母缩写
${MONTH_NAME_FULL} - 完整的月份名
风格参考
# -*- coding: utf-8 -*-#
#-------------------------------------------------------------------------------
# Name: ${NAME}
# Description:
# Author: ${USER}
# Date: ${DATE}
#-------------------------------------------------------------------------------
pycharm的docstring文档
设置位置：
Preferences -> Tools -> Python Integrated Tools -> Docstrings -> Docstring format
五种风格：
Plain
reStructuredText
Numpy
Google
Epytext
风格示例
# Plain
def foo1(a, b):
"""
"""
return a+b
# reStructuredText
def foo2(a, b):
"""
:param a:
:param b:
:return:
"""
return a+b
# Numpy
def foo3(a, b):
"""
Parameters
----------
a
b
Returns
-------
"""
return a+b
# Google
def foo4(a, b):
"""
Args:
a:
b:
Returns:
"""
return a + b
# Epytext
def foo(a, b):
"""
@param a:
@param b:
@return:
"""
return a+b
添加方法注释 自定义全局快捷键
Docstring format 已经可以自动格式化输出docstrings，但无法加上创建人、创建时间、修改人、修改时间、版权声明；有些规范建义这些元素写在文件头部，而对于协同开发同一文件，觉得还是需要把这些元素加在各个方法里面，会更清晰明了。
可通过pyCharm的 Live Templates 自定义模板实现。
Live Templates中设置路径如下：
File -> Settings -> Editor -> Live Templates
点击+ 创建新的模板，会自动生成user组，Abbreviation中代表快捷键，Description中是对其描述，
设置完快捷键以后需要设置使用范围，以及添加模板内容，如有使用到变量，需要设置变量，然后保存
应用范围
设置变量
一般 使用范围，变量，模板内容都需要设置
模板文件参考：
:now_time: $DATE$ $TIME$
"""
Parameters
----------
Returns
-------
Examples
--------
--------
:Author: lduml
:Create: $DATE$ $TIME$
"""