欢迎来到代码驿站!

Python代码

当前位置:首页 > 软件编程 > Python代码

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

时间:2022-05-06 09:21:10|栏目:Python代码|点击:

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:
"""

上一篇:Python OpenCV特征检测之特征匹配方式详解

栏    目:Python代码

下一篇:浅谈python字符串方法的简单使用

本文标题:pycharm自动生成文件注释和函数注释

本文地址:http://www.codeinn.net/misctech/201149.html

推荐教程

广告投放 | 联系我们 | 版权申明

重要申明:本站所有的文章、图片、评论等,均由网友发表或上传并维护或收集自网络,属个人行为,与本站立场无关。

如果侵犯了您的权利,请与我们联系,我们将在24小时内进行处理、任何非本站因素导致的法律后果,本站均不负任何责任。

联系QQ:914707363 | 邮箱:codeinn#126.com(#换成@)

Copyright © 2020 代码驿站 版权所有