Pycharm自动添加文件头注释和函数注释参数的方法

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

1.自动添加文件头注释

文件头模板设置路径

Settings->Editor->File and Code Templates->Python Script

在右侧箭头区域添加模板代码。

参考模板：

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
'''
@Project ：${PROJECT_NAME}
@File ：${NAME}.py
@Author ：吾非同
@Date ：${DATE} ${TIME}
'''

然后在pycharm中，新建python文件，自动添加文件头注释，效果如下：

模板常用内置变量

格式 作用效果
${PROJECT_NAME} 项目名
${PRODUCT_NAME} 集成开发环境
${NAME} 文件名
${USER} 用户名（指登录电脑的那个用户名）
${DATE} 当前系统的年月日
${TIME} 当前系统的时分秒
${YEAR} 当前年份
${MONTH} 当前月份（形式：07）
${MONTH_NAME_SHORT} 当前月份（形式：7月）
${MONTH_NAME_FULL} 当前月份（形式：七月）
${DAY} 当天
${HOUR} 当前小时
${MINUTE} 当前分钟
${SECOND} 当前秒钟

大家可以根据自己的喜好，设置一个专属的文件注释版本。

2.快速添加函数及参数注释

在完成函数定义时，输入三个"""回车即可，自动添加函数注释参数。

编写好注释信息后，使用函数时，可以使用如下快捷键查看函数信息：

mac：ctl+J

windows：ctrl+q

到此这篇关于Pycharm自动添加文件头注释和函数注释参数的方法的文章就介绍到这了,更多相关Pycharm自动添加注释 内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • Pycharm在创建py文件时,自动添加文件头注释的实例

    1.选择File -> Settings 2.选择 File and Code Templates -> Files -> Python Script 编辑代码的样式 #!/usr/bin/env python # encoding: utf-8 ''' @author: caopeng @license: (C) Copyright 2013-2017, Node Supply Chain Manager Corporation Limited. @contact: deamoncao

  • Pycharm自动添加文件头注释和函数注释参数的方法

    Pycharm应该是学python必用的编辑器了,关于它的使用之前已经写过几篇文章,今天再给大家继续介绍两个pycharm的小技巧,希望对大家有用. 1.自动添加文件头注释 文件头模板设置路径 Settings->Editor->File and Code Templates->Python Script 在右侧箭头区域添加模板代码. 参考模板: #!/usr/bin/env python # -*- coding: UTF-8 -*- ''' @Project :${PROJECT_N

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

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

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

  • Python 添加文件注释和函数注释操作

    1.文件添加方式: pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者.日期等必要信息,使用比较方便,配置十分简单. #!C:\pythonCode # -*- coding: utf-8 -*- # @Time : ${DATE} ${TIME} # @Author : hlx # @File : ${NAME}.py # @Software: ${PRODUCT_NAME} 2.自动生成函数注释,包括参数和返回值.使用方法,函数定义时,直接输入三个双引

  • jQuery实现ajax回调函数带入参数的方法示例

    本文实例讲述了jQuery实现ajax回调函数带入参数的方法.分享给大家供大家参考,具体如下: 不带参数的写法: function pass(htmlId,auditingFlag){ var url = 'ad_auditing.action'; var params = { 'adInfoPOJO.auditingFlag' : auditingFlag }; dataType: "text"; jQuery.post(url, params, callbackFun); } //

  • Pycharm创建python文件自动添加日期作者等信息(步骤详解)

    Pycharm创建python文件自动添加日期作者等信息(步骤详解)

    第一步 找到 Preferences,点击进入.进入后找到 Editor – File and Code Templates – Python Script . 第二步 添加自己所需要的信息 第三步 添加完成后,点击 OK 键进行保存. 新建python文件就会看到已添加的默认信息. 常用配置 #-- coding: utf-8 -- #@Time : ${DATE} ${TIME} #@Author : XXXX #@Email : XXXX@qq.com #@File : ${NAME}.p

  • PHP 下载文件时如何自动添加bom头及解释BOM头和去掉bom头的方法

    PHP 下载文件时自动添加bom头,首先需要大家弄清楚,什么是bom头?在Windows下用记事本之类的程序将文本文件保存为UTF-8格式时,记事本会在文件头前面加上几个不可见的字符(EF BB BF),就是所谓的BOM(Byte order Mark). 在utf-8编码文件中BOM在文件头部,占用三个字节,用来标示该文件属于utf-8编码,现在已经有很多软件识别bom头,但是还有些不能识别bom头,比如PHP就不能识别bom头,这也是用记事本编辑utf-8编码后执行就会出错的原因了. 不仅限

  • Javascript基于AJAX回调函数传递参数实例分析

    本文实例讲述了Javascript基于AJAX回调函数传递参数的方法.分享给大家供大家参考,具体如下: 前面介绍了<javascript实现html页面之间参数传递的四种方法>,这里针对ajax参数传递做一分析. 在Javascript 中,特别是在AJAX中,回调函数常常是一个函数名,没有地方放入参数,如下面的AJAX代码,在成功后将调用回调函数callback,但callback是有参数的,如何把参数传进来呢? var callback = function(p1){ //do somet

  • Pycharm创建文件时自动生成文件头注释(自定义设置作者日期)

    有时候我们传.py文件给别人时,需要添加一些文件头注释.为了不用每次新建文件时都去手动添加作者.创建日期等信息,我们可以设置一套模板,在新建.py文件的时候自动使用这套模板. 一. 模板设置 1.1 操作步骤 打开pycharm后,点击 File --> Settings ,进入设置界面 点击 Editor --> File and Code Templates --> Python Script 在右侧添加上你想注释的内容,如下图所示 代码模板如下(可以根据自己需要进行修改) #!/u

  • C#实现为类和函数代码自动添加版权注释信息的方法

    本文实例讲述了C#实现为类和函数代码自动添加版权注释信息的方法,分享给大家供大家参考之用.具体方法如下: 以web项目为例: 一:给类加注释 1.在visual studio 的安装路径下 如:[盘符]:/Program files/Microsoft Visual Studio 8/Common7/IDE/ItemTemplates/web/cshare/2052/class.zip ,将里面的class.cs改为: /*------------------------------------

随机推荐