今天小编给大家分享一下pycharm怎么实现自动生成文件注释和函数注释的相关知识点,内容详细,逻辑清晰,相信大部分人都还太了解这方面的知识,所以分享这篇文章给大家参考一下,希望大家阅读完这篇文章后有所收获,下面我们一起来了解一下吧。
1. 文件注释
File -> settings -> Editor -> File and Code Templates -> Python Script
pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者、日期等必要信息,使用比较方便,配置十分简单。
按照1-5的路径选项即可。在5中填写想要的注释。
我的模板:
# -*- encoding: utf-8 -*-
"""
@File : ${NAME}.py
@Contact : emac.li@cloudminds.com
@License : (C)Copyright 2018-2021
@Modify Time @Author @Version @Desciption
------------ ------- -------- -----------
${DATE} ${TIME} Emac.li 1.0 None
"""
2. 函数注释
自动生成函数注释,包括参数和返回值。
使用方法,函数定义时,直接输入三个双引号后回车,例如:
def a(b,c):
另起一行,输入三个引号,后回车
def a(b,c):
"""
结果:
def a(b,c):
"""
:param b:
:param c:
:return:
"""
以上就是“pycharm怎么实现自动生成文件注释和函数注释”这篇文章的所有内容,感谢各位的阅读!相信大家阅读完这篇文章都有很大的收获,小编每天都会为大家更新不同的知识,如果还想学习更多的知识,请关注编程网行业资讯频道。