Pycharm自动生成文件头部注释和函数注释

文件头部注释

新建py文件后, 自动生成头部注释
Preferences | Editor | File and Code Templates(Windows 从Setting)

#!/usr/bin/env python3.6.5
# -*- coding: UTF-8 -*-
"""
Author: 林子
Date: ${DATE} ${TIME}
docs: ${END}

"""

函数自动注释

定义函数/方法后,输入三引号, 按回车, 自动填充参数的注释及返回值

def test(a, b):
	"""
	test函数
	:param a: 字符串a
	:param b: 字符串b
	:return: None
	"""

直接回车无效的,查看设置
Preferences | Tools | Python Integrated Tools(Windows 从Setting)
Docstring format 选择 reStructuredText 或者 epytext 样式稍微不一样

• For reStructuredText: :param tags for each parameter declared in the function signature, and :return tag.
• For epytext: @param tags for each parameter declared in the function signature, and @return tag.