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

作者:DaisyLinux 时间:2023-10-07 04:17:18 

1. 文件注释

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

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


# -*- 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自动生成文件注释和函数注释

来源:https://www.cnblogs.com/a00ium/p/15039199.html

标签:pycharm,文件注释,函数注释
0
投稿

猜你喜欢

  • ASP压缩ACCESS数据库实例

    2009-01-19 11:47:00
  • Tensorflow2.10实现图像分割任务示例详解

    2021-08-31 13:14:47
  • ASP导出Excel数据的四种办法

    2007-08-26 18:32:00
  • Python内置函数—vars的具体使用方法

    2021-05-07 04:09:57
  • flask-script模块的具体使用

    2022-04-08 10:53:34
  • Oracle RMAN快速入门指南

    2024-01-20 10:49:09
  • python之dlib包安装失败问题及解决

    2022-11-20 09:33:55
  • Python读csv文件去掉一列后再写入新的文件实例

    2022-05-13 14:04:12
  • python3.X 抓取火车票信息【修正版】

    2022-01-26 01:24:53
  • Python dict和defaultdict使用实例解析

    2022-12-24 20:44:19
  • zabbix通过percona插件监控mysql的方法

    2024-01-23 04:51:22
  • 让你知道codepage的重要,关于多语言编码

    2008-01-31 12:04:00
  • python 获取图片分辨率的方法

    2022-02-19 12:03:56
  • python互斥锁、加锁、同步机制、异步通信知识总结

    2023-10-08 21:17:16
  • Python打印“菱形”星号代码方法

    2023-02-05 17:34:42
  • python判断一个变量是否已经设置的方法

    2022-06-09 19:33:15
  • 利用 Python ElementTree 生成 xml的实例

    2022-04-14 08:32:48
  • python tkinter模块的简单使用

    2021-11-20 16:52:33
  • Python 用户输入和while循环的操作

    2023-07-22 22:17:33
  • mysql 8.0.28 安装配置方法图文教程

    2024-01-16 16:40:26
  • asp之家 网络编程 m.aspxhome.com