【Python】用pycharm添加文件注释和方法注释

理想目标:想要pycharm自动添加注释,在注释里面,首先可以写这个文件是干嘛的,然后细化到每个文件是干嘛的;

实现效果:

文本注释:

注释格式这里可以复制粘贴:

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : ${DATE} ${TIME}
# @Author  : 我的名字
# @File    : ${NAME}.py
# @Description : 这个函数是用来balabalabala自己写

方法注释:

发现有时候按'''只是单纯的多行注释,解决办法:要从上一行的末尾按回车键到下一行,然后再按''',回车才会有自动注释;

后来发现 第4这个步骤 原来选的goole不够详细,选reStrucuredText is better更好,选这个最后的效果是这样的:

可以看到有哪里几个输入变量,有哪些返回值都很清楚;

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值