【Python】【Pycharm】函数说明文档的编写规则

各位在工作时候经常使用函数来封装自己的代码以便于重复利用,提高工作效率，然后很多人会忽略对自己封装函数的说明文档的编写,可能只是在写这个方法的时候把自己一些当时的想法或者一些需要注意的点直接通过编辑器本身的注释规则在旁边加上规则，或者根本就不写任何的文档注释，这样对以后自己或者他人阅读封装的这段代码会有很大的困扰，Pycharm 做为比较健壮的Python编辑器提供了一种很便利的方法;
![Pycharn 函数说明文档1](https://img-blog.csdnimg.cn/20191117174643665.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU2NjE2Nw==,size_16,color_FFFFFF,t_70)
![](https://img-blog.csdnimg.cn/20191117175342270.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDU2NjE2Nw==,size_16,color_FFFFFF,t_70)

如图所示
点击函数名后鼠标停留大概两秒会出现如上的小黄色灯泡
下拉选择 'insert dicumentation string stub’选项
Pycharm会自动生成说明文档
包括 自己的说明 传参的说明以及返回值的说明
总之非常的方便 ‘