參考
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 : example@163.com
@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$
"""