[开发工具]【转】pycharm修改文件头注释以及函数注释模板

1.修改函数注释模板

引用自 https://www.cnblogs.com/wangshuyi/p/13718183.html

在pycharm窗口中，依次选择：File→Setting→Tools→Python Integrated Tools→Docstrings→Docstring format: 在下拉菜单中选择“reStrturedText” 或是其他你喜欢的格式。

2.自动添加文件头注释

引用自 https://zhuanlan.zhihu.com/p/329967393

在pycharm窗口中，依次选择：Settings->Editor->File and Code Templates->Python Script

2.1参考模板

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
'''
@Project ：${PROJECT_NAME} 
@File    ：${NAME}.py
@Author  ：POK
@Date    ：${DATE} ${TIME} 
'''

2.2快速添加函数及参数注释

在完成函数定义时，输入三个"""回车即可，自动添加函数注释参数。

编写好注释信息后，使用函数时，可以使用如下快捷键查看函数信息：

mac：ctl+J

windows：ctrl+q