理想目标:想要pycharm自动添加注释,在注释里面,首先可以写这个文件是干嘛的,然后细化到每个文件是干嘛的;
实现效果:
![](https://img-blog.csdnimg.cn/img_convert/3bcad5cdc8ca8414ab600fa56d843eba.png)
文本注释:
![](https://img-blog.csdnimg.cn/img_convert/6d9ae7b5adea9d2d6515eb37e5866920.png)
注释格式这里可以复制粘贴:
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time : ${DATE} ${TIME}
# @Author : 我的名字
# @File : ${NAME}.py
# @Description : 这个函数是用来balabalabala自己写
方法注释:
![](https://img-blog.csdnimg.cn/img_convert/eb79f1e26c6a1c2fd5ceaa4d89702fb9.png)
发现有时候按'''只是单纯的多行注释,解决办法:要从上一行的末尾按回车键到下一行,然后再按''',回车才会有自动注释;
后来发现 第4这个步骤 原来选的goole不够详细,选reStrucuredText is better更好,选这个最后的效果是这样的:
![](https://img-blog.csdnimg.cn/img_convert/e40c7fa751edfc1be56d0ee75cb0937d.png)
可以看到有哪里几个输入变量,有哪些返回值都很清楚;