使用PyCharm为Python函数增加注释

创建于：@2020.03.30
修改于：@2020.03.31、@2020.09.28

使用PyCharm为Python函数 自动增加注释。

1. 三个引号调不出模板

• 进入：File | Settings | Tools | Python Integrated Tools | Docstring format
• 选择：reStructuredText
  
• 我这儿一开始的默认值为plain，也就是空的。
• 去函数内的下一行，打三个引号，然后按换行。正确提示了。

参考连接：请问PyCharm有没有可以自动生成函数注释的插件？

2. 利用函数的灯泡提示

把光标放在函数名中，左上角亮起小灯泡，点击小灯泡，选择第二个。

参考连接：ython中使用PyCharm为函数及参数增加注释

3. .py文件模板

• 打开PyCharm IDE，进入File->settings->Editor->File and Code Templates->Python Script

• 添加以下内容：

# -*- coding:UTF-8 -*-

# author:${USER}
# contact: test@test.com
# datetime:${DATE} ${TIME}
# software: ${PRODUCT_NAME}
     
"""
文件说明：
    
"""

• 测试：创建新.py文件时，在文件的开始位置，上述内容自动出现。
• 参考连接： pycharm 自动生成文件注释和函数模板
• 避免 - SyntaxError: (unicode error) ‘utf-8’ 的办法是文件第一行加入 ：# -*- coding:UTF-8 -*-

4. 代码片段快捷模板

• pycharm 自动生成文件注释和函数模板
• pycharm自定义代码片段

设置后，我的类没起作用。这是为什么？