Pychram自动添加文件头注释和添加方法注释

添加文件头注释

打开Pychram，选则
File->setting->Editor->File and Code Templates 选中Python Script,添加以下模板代码：

#!/usr/bin/env python
# encoding: utf-8
'''
@Author  : XXXX
@License : XXXX.
@Contact : XXX@XXX.XXX
@Software: garner
@Site    : ${SITE}
@File    : ${NAME}.py
@Time    : ${DATE} ${TIME}
@Desc    :
'''

修改相应的信息，保存即可。现在新建一个.py文件便会自动添加以上相关的额注释信息。

函数注释

如上图，将鼠标指针光标移动到方法名的区域，按alt+enter，或者等待出现一个灯泡的图标并点击，如下图：

选择下拉框中的Insert documentation string stub，机会出现类似图1的方法参数注释，若有返回值，还会出现返回值注释。