pycharm使用筆記--自動生成文件注釋和函數注釋

1. 文件注釋

pycharm提供了一個在新建文件自動生成文件頭注釋的功能，可以實現自動生成運行環境，作者、日期等必要信息，使用比較方便，配置十分簡單。

 打開方式：File-->settings-->Editor-->File and Code Templates-->Python Script

 

按照1-5的路徑選項即可。在5中填寫想要的注釋。

我的模板：

預定義的變量

# !/usr/bin/env python3
# _*_ coding:utf-8 _*_
"""
@File     : ${NAME}.py
@Project  : ${PROJECT_NAME}
@Time     : ${DATE} ${TIME}
@Author   : Li JinTao
@Contact_1: [e-mail]
@Contact_2: [e-mail]
@Software : ${PRODUCT_NAME}
@License  : (C)Copyright 2018-2028, Taogroup-NLPR-CASIA
@Last Modify Time      @Version     @Desciption
--------------------       --------        -----------
${DATE} ${TIME}        1.0             None
"""

if __name__ == '__main__':
    pass

變量	描述	例子
${DATE}	當前系統日期	2019 / 11 / 21
${DAY}	當月第幾天	21
${DS}	$的轉義	$
${FILE_NAME}	文件名	test.py
${HOUR}	當前小時	14
${MINUTE}	當前分鍾	16
${MONTH}	當前月份	11
${MONTH_NAME_FULL}	當前月份全稱	十一月
${MONTH_NAME_SHORT}	當前月份簡稱	11
${NAME}	文件、類、接口的名稱	test
${ORGANIZATION_NAME}	組織名	huawei
${PRODUCT_NAME}	IDE的名	PyCharm
${PROJECT_NAME}	當前項目名	test
${TIME}	當前系統時間	14: 16
${USER}	當前用戶登錄名	Administrator
${YEAR}	當前年份	2019

2. 函數注釋

自動生成函數注釋，包括參數和返回值。
使用方法，函數定義時，直接輸入三個雙引號后回車，例如：

def a(b,c):

另起一行，輸入三個引號，后回車

def a(b,c):
"""

結果：

def a(b,c):
    """
    :param b:
    :param c:
    :return:
    """