Pycharm自动生成文件头部注释和函数注释

ゞ浴缸里的玫瑰 2023-07-17 14:25 14阅读 0赞

### 文件头部注释 ###

新建py文件后, 自动生成头部注释  
Preferences | Editor | File and Code Templates(Windows 从Setting)

#!/usr/bin/env python3.6.5
    # -*- coding: UTF-8 -*-
    """ Author: 林子 Date: ${DATE} ${TIME} docs: ${END} """

![文件头注释][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbnppMTk5NA_size_16_color_FFFFFF_t_70]

### 函数自动注释 ###

定义函数/方法后,输入三引号, 按回车, 自动填充参数的注释及返回值

def test(a, b):
    	""" test函数 :param a: 字符串a :param b: 字符串b :return: None """

直接回车无效的,查看设置  
Preferences | Tools | Python Integrated Tools(Windows 从Setting)  
Docstring format 选择 reStructuredText 或者 epytext 样式稍微不一样

*  For reStructuredText: `:param` tags for each parameter declared in the function signature, and `:return` tag.
 *  For epytext: `@param` tags for each parameter declared in the function signature, and `@return` tag.  
    ![函数注释][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbnppMTk5NA_size_16_color_FFFFFF_t_70 1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbnppMTk5NA_size_16_color_FFFFFF_t_70]: /images/20230528/191ca680587a4b49995b23f31ee265c9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xpbnppMTk5NA_size_16_color_FFFFFF_t_70 1]: /images/20230528/f3f956db75164754a6cc4e2b9b7c2cfd.png

发表评论取消回复

表情：

评论列表（有 0 条评论，14人围观）

还没有评论，来说两句吧...

相关阅读

相关 [python]pycharm自动生成函数注释

函数涉及到多个参数的时候注释是一个不可或缺的好帮手，手动生成参数又是一件比较费事的事情，我们能想到的pycharm也替我们想到了，并给出了比较不错的解决方案，一次设置长期有效；

秒速五厘米/ 2024年03月27日 11:09/ 0 赞/ 91 阅读

相关 Pycharm自动生成文件头部注释和函数注释

文件头部注释新建py文件后, 自动生成头部注释 Preferences | Editor | File and Code Templates(Windows 从Se

ゞ浴缸里的玫瑰/ 2023年07月17日 14:25/ 0 赞/ 15 阅读

相关 qt中添加注释的快捷键_koroFileHeader：一个用于生成文件头部注释和函数注释的插件...

今天给大家分享的这个工具呢？对于使用 VS Code 的同学来讲，是一个好东西。 koroFileHeader，一个在 vscode 中用于生成文件头部注释和函数注释的插件，

Myth丶恋晨/ 2023年01月03日 14:10/ 0 赞/ 187 阅读

相关 Pycharm自动添加文件头注释和函数注释参数

Pycharm应该是学python必用的编辑器了，关于它的使用之前已经写过几篇文章，今天再给大家继续介绍两个pycharm的小技巧，希望对大家有用。 1.自动添加文件头注释

待我称王封你为后i/ 2022年12月11日 15:03/ 0 赞/ 268 阅读

相关 IDEA 自动生成类注释和方法注释

自动生成类注释新建类，自动生成类注释的模板配置 `File->Settings->Editor->File and Code Templates->C

末蓝、/ 2022年12月04日 08:48/ 0 赞/ 212 阅读

相关 IEDA 自动生成类注释和方法注释

文章目录新建类，自动生成类注释的模板配置通过快捷键，添加类注释和方法注释的模板设置类注释【快捷键：cls + TAB】方法

叁歲伎倆/ 2022年11月17日 05:26/ 0 赞/ 248 阅读

相关 vim创建程序文件自动添加头部注释

在编写文件时有时需要添加一些头部注释，例如：作者、创建时间、邮件、版本说明等。如果每次都重复写这些注释感觉很麻烦，因此我们可以按需要自动添加注释。进入vim主配置文

刺骨的言语ヽ痛彻心扉/ 2022年10月01日 07:54/ 0 赞/ 321 阅读

相关 vscode添加新建文件头部注释和函数注释

> 新建文件作者注释和方法函数注释 > 搜索添加koroFileHeader 插件，安装之后reload > > ![watermark_type_ZmFuZ

Love The Way You Lie/ 2022年04月02日 03:16/ 0 赞/ 1152 阅读

相关 intellij自动生成java代码注释(java文件注释和方法注释)

idea编辑器设置java类和方法注释自动生成参考链接： [https://blog.csdn.net/pucao\_cug/article/details/7030

偏执的太偏执、/ 2022年03月29日 12:52/ 0 赞/ 312 阅读

相关 IDEA创建CLASS时自动生成头部文档注释

注释效果： ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L

港控/mmm°/ 2021年07月26日 13:33/ 0 赞/ 485 阅读