Pycharm自动添加文件头注释和函数注释参数的方法
作者：吾非同 发布时间：2023-06-05 04:01:51
标签：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
来源：https://blog.csdn.net/XingLongSKY/article/details/108906563
0
投稿猜你喜欢
- js对文字进行编码涉及3个函数：escape,encodeURI,encodeURIComponent，相应3个解码函数：unescape,
- 本文实例介绍了python实现井字棋游戏的方法，分享给大家，具体内容如下windows7下python3.4.0编译运行通过。由于采用了cm
- 这两天为用bottle+mongodb写的一个项目加上登录功能,无奈怎么都获取不到保存的cookie,文档给出让我们这样操作cookie的代
- 如何在Typescript中使用for...in ？本人在TS中用for...in出现了些问题，也想到了一些解决方法。那么先来看看下面报错的
继续练手，根据之前获取汽油价格的方式获取了金价，暂时没钱投资，看看而已#!/usr/bin/env python# -*- coding:- 一、if语句if 语句让你能够检查程序的当前状态，并据此采取相应的措施。if语句可应用于列表，以另一种方式处理列表中的大多数元素，以及特定值
- 本文仅针对 Ubuntu 操作系统环境，其他系统环境待日后遇到再补充。本文主要内容参考Linux公社（https://www.linuxid
- 本文实例讲述了Python显示进度条的方法，是Python程序设计中非常实用的技巧。分享给大家供大家参考。具体方法如下：首先，进度条和一般的
- 在windows下写bat的时候，通过pause命令，可以暂停程序运行，例如经常见的程序会在终端提示”按任意键继续……”,用户在终端回车后程
- 本文实例讲述了php简单实现批量上传图片的方法。分享给大家供大家参考，具体如下：<?phpfunction upload_multi(
- 获取一组href元素属性的值lst = driver.find_elements_by_class_name("ib-it-tex
- 下面这个函数使用FSO对象来判断服务器上的某个文件是否存在：<％Private Function Dir(byVa
- 1. 代码完整的源代码：import torchfrom torch import nn# 定义一个LSTM模型class LSTM(nn.
- 在安装tensorflow完成后，import tensorflow as tf出现问题，问题如下：>>> import
- 首先我们一起来看下 Character entities references （HTML Entities）和 Numeric Chara
- django-pagination这是一个python包，来自github上的一个项目，很容易用。不过这是一个懒人工具，好吧（工具理性）。不
- 定义线程最简单的方法：使用target指定线程要执行的目标函数，再使用start()启动。语法：class threading.Thread
- 最新在学习Python的基础入门系列课程，今天学习到使用python 的内置库smtplib发送邮件内容。使用Python发送邮件步骤简单：
- 有用的 Python 单行代码片段，只需一行代码即可解决特定编码问题！在本文中，云朵君将分享20 个 Python 一行代码，你可以在 30
- 代码已经调通，跑出来的效果如下：# coding=gbkimport torchimport matplotlib.pyplot as pl
