华域联盟 Python pycharm自动生成文件注释和函数注释

pycharm自动生成文件注释和函数注释

文章目录[隐藏]

1. 文件注释

File -> settings -> Editor -> File and Code Templates -> Python Script
pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者、日期等必要信息,使用比较方便,配置十分简单。
按照1-5的路径选项即可。在5中填写想要的注释。
我的模板:

# -*- encoding: utf-8 -*-
'''
@File    :   ${NAME}.py   
@Contact :   [email protected]
@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文件注释函数注释内容请搜索华域联盟以前的文章或继续浏览下面的相关文章希望大家以后多多支持华域联盟!

您可能感兴趣的文章:

本文由 华域联盟 原创撰写:华域联盟 » pycharm自动生成文件注释和函数注释

转载请保留出处和原文链接:https://www.cnhackhy.com/30895.htm

本文来自网络,不代表华域联盟立场,转载请注明出处。

作者: sterben

发表回复

联系我们

联系我们

2551209778

在线咨询: QQ交谈

邮箱: [email protected]

工作时间:周一至周五,9:00-17:30,节假日休息

关注微信
微信扫一扫关注我们

微信扫一扫关注我们

关注微博
返回顶部