Pycharm自定义文件头和函数注释

1、文件头注释

按照这个顺序 File>settings>Editor>File and Templates>Python Script,找到文件和代码模板。
在这里插入图片描述添加内容如下:

'''
@File  :${NAME}.py
@Author:YangMiao
@Date  :${DATE}${TIME}
@Desc  :
'''

关于自定义函数模板参考这里:参考链接

2、函数注释

选择自己喜欢的风格,个人比较喜欢google的模板。
在这里插入图片描述
Google模板如下user函数所示,Epytext格式如user2函数所示,个人比较喜欢google的风格。
在这里插入图片描述
注意:缩进,三引号 + Enter

  • 3
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 4
    评论
PyCharm是一款功能强大的集成式开发环境,提供了许多便捷的功能来提高代码编写效率。其中包括自动添加文件函数注释的功能。 对于自动添加文件PyCharm可以根据我们使用的库或模块来自动引入相应的文件。当我们在代码中使用了某个函数或类时,PyCharm会自动检测到并提示是否需要引入相应的文件。我们只需要点击确认即可自动添加文件。 例如,当我们使用了Python标准库中的math模块的函数时,在我们调用该函数之前,PyCharm会提示我们是否需要引入math文件。只需要点击确认,PyCharm就会自动将`import math`语句添加到我们的代码中,避免了手动添加文件的麻烦。 对于函数注释PyCharm提供了一个快捷键,可以自动在函数定义的上方生成函数注释的模板。我们只需要在函数定义的上一行输入三个引号('''),然后按下快捷键,PyCharm就会自动生成一个函数注释的模板。我们可以在生成的模板中填写该函数的参数、返回值和功能说明等信息。 函数注释可以提供给其他开发人员更好的代码可读性和理解性,帮助开发人员更快地了解函数的功能和使用方式。同时,函数注释也可以被PyCharm的代码提示功能所利用,当其他开发人员在代码中调用该函数时,PyCharm会根据我们提供的函数注释来智能提示函数的参数和返回值等信息。 总的来说,PyCharm的自动添加文件函数注释功能可以提高代码编写的效率和代码的可读性,使我们能更好地利用该开发环境进行Python程序开发。
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

猫哥说

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值