【Python自学笔记】Pycharm如何快速给python函数添加说明文档&参数注释

Pycharm添加参数注释（说明文档）

我们在写 Python函数 或 自定义类 的时候，往往会需要给里面的参数或者变量添加注释，这样的作用是使其他使用的人一个很好的说明，从而让他人更好的使用我们的代码

快速添加注释（Pycharm环境）

• 我们在写好一个函数之后，直接把鼠标移至函数名上等一两秒中后，pycharm就会出现一个黄色的💡图标
• 然后点击💡图标右侧的下三角
• 选择Insert documentation string stub
  
• 然后手动填写相应的说明即可

查看注释

• 调用函数，把鼠标放在函数名上然后可以通过两种方法查看注释
  –快捷键：Ctrl + Q
  – 工具栏选择View --> Quick Documentation
• 通过以上两种方法可以查看设置好的注释说明