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自动生成文件注释和函数注释的文章就介绍到这了,更多相关pycharm文件注释函数注释内容请搜索hwidc以前的文章或继续浏览下面的相关文章希望大家以后多多支持hwidc!
【文章出处:国外服务器 转发请说明出处】