在学习过了python的基础知识之后，大家都会知道在python中是可以给代码添加注释的 。那么一般的注释分为单行注释和多行注释，除了这两种之外还有一个写在函数内的注释被称之为文档注释 。本文来介绍的就是pycharm编辑器添加文档注释，以及快捷设置函数注释的方法 。
文章插图
一、快捷添加函数注释
打开pycharm编辑器之后点击顶部菜单栏File里面的settings选项进入编辑器设置页，在设置页里面依次选择Tools-Python Intrgrated Tools这两个选项 。选择完成后会在右侧空白出现相对应的设置项，将Docstring format里面的选项改成Plain然后点击Ok保存设置 。
设置保存完毕之后，只需要在函数的上面输入三个单双引号并且回车，就会自动的出现注释信息 。而这些注释信息是根据模板来生成的，主要的信息有项目名、文件名、开发者、更新时间之类的 。
二、添加文档注释
【Pycharm如何为python函数添加文档注释？Pycharm中函数怎么快捷添加注释】文档注释和上面讲的多行注释不同，它需要添加在函数的内部，并且只能从函数内部的第一行开始写 。在pycharm打开的python文件之中，将鼠标移动到函数名上并且悬停一段时间，就会出现一个小灯泡 。
点击这个小灯泡右上角的下拉箭头就会出现很多的选择，点击Inset开头的选项就可以为这个函数添加有模板的文档注释了，注释内的信息可以自己去修改 。
以上就是关于“Pycharm如何为python函数添加文档注释？Pycharm中函数怎么快捷添加注释”的全部内容了，希望对你有所帮助 。
推荐阅读
- Pycharm怎么设置注释颜色？Pycharm编辑器如何更改python注释样式
- Flask框架怎么重定向？Python框架flask出现404如何跳转到错误页面
- Flask框架怎么处理cookie？Python库flask如何获取cookie
- Python框架flask实现文件上传怎么做？Flask如何上传文件
- Flask模板有什么用？Python框架flask如何使用模板
- Flask框架怎么自定义路由？Python中flask如何设置路由访问方式
- 天猫供销平台入口在哪？如何选择供货商？
- 淘宝合作中的供应商如何取消？怎么成为供应商？
- 淘宝店铺如何引流推广？有哪些方法？
- 淘宝定金可以退款吗？如何退款？