0. Intro

如何自动化写出像这样shai的文件的注释呢：
如何写出这样的函数注释呢，或者说函数的描述？鼠标放上去就自动显示描述，而且在括号内ctrl+p可以显示变量提示。
本文以pycharm为例，本教程不够完整，自己写写函数够用啦
如果有其他的技巧欢迎分享喔

1. 文件注释自动化添加

pycharm中，按照如下步骤找到写注释的地方：
我的注释格式是这样的：

#!/usr/bin/env python
# -*- coding: utf-8 -*-
# @Time    : ${DATE} ${TIME}
# @Author  : 我的名字
# @File    : ${NAME}.py
# @Description : 这个函数是用来balabalabala自己写

前两行win系统无所谓，ubuntu的话要注意写法，涉及到python环境和编码格式；其他可以选择的参数，以及内置变量可以参考这篇博客：

2. 函数注释、描述添加

这个就没办法自动化啦（如果有请告诉我pls）
以这个有2个参数的函数为例，这个函数的作用是从一个大数据集生成一个只有20行的小数据集：

GenData20(outcomes_orignal_path, outcome20_path)

首先是函数的description怎么添加：

点击后会发现自动生成了一些注释：

然后就可以写针对参数和返回值的描述，当然你也可以自己加其他的对于函数功能的描述：注意这有一行回车
上面的几张图可以发现，我的函数参数是有格式提示的：

这个也可以快速添加~方法依然是鼠标放到函数名上，点击小灯泡，add这一项;

然后改成你需要的参数格式就好，返回值没有可以写个None

3. 查看注释

我们添加的文件注释信息在每次创建新文件的时候都会自动生成
我们添加的函数信息有多种查看方式：
比如你可以鼠标放在调用函数的地方静止不动：

或者你光标方法函数名上+摁住ctrl，会出来一个简短的函数描述。
当然还可以使用参数提示，在调用函数的时候，在括号里使用ctrl+p：

本教程不够完整，自己写写函数够用啦
如果有其他的技巧欢迎分享喔

pycharm如何添加文件注释和函数注释相关推荐

回调函数自定义传参_koroFileHeader：一个用于生成文件头部注释和函数注释的插件...
小金子读完需要 2分钟速读仅需 1 分钟大家好,我是你们的小金子. 今天给大家分享的这个工具呢?对于使用 VS Code 的同学来讲,是一个好东西. koroFileHeader,一个在 vsc ...
vscode 注释快捷键_koroFileHeader：一个用于生成文件头部注释和函数注释的插件
大家好,我是你们的小金子. 今天给大家分享的这个工具呢?对于使用 VS Code 的同学来讲,是一个好东西. koroFileHeader,一个在 vscode 中用于生成文件头部注释和函数注释的插件 ...
vsCode设置文件注释和函数注释使用koroFileHeader插件
1.安装koroFileHeader插件 2.配置内置文件找到配置文件找到settings.json文件在settings.json中添加如下配置(如果重复的替换即可) //文件注释" ...
MDK5插件：代码格式整理、文件注释、函数注释
文章目录前言一.插件使用&&效果演示 1.代码格式整理 2.函数注释 3.文件注释二.安装插件 1.下载插件 2.导入插件三.设置快捷键总结参考文章和资料前言近日,本人 ...
8 pycharm 快捷键_Pycharm自动添加文件头注释和函数注释参数
Pycharm应该是学python必用的编辑器了,关于它的使用之前已经写过几篇文章,今天再给大家继续介绍两个pycharm的小技巧,希望对大家有用. 1.自动添加文件头注释文件头模板设置路径 Set ...
Pycharm自动添加文件头注释和函数注释参数
Pycharm应该是学python必用的编辑器了,关于它的使用之前已经写过几篇文章,今天再给大家继续介绍两个pycharm的小技巧,希望对大家有用. 1.自动添加文件头注释文件头模板设置路径 Set ...
pycharm 自动生成文件注释和函数注释
1. 文件注释 pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者.日期等必要信息,使用比较方便,配置十分简单.在anaconda 的spider也有类似的功能 ...
pycharm使用笔记3-自动生成文件注释和函数注释
1. 文件注释 pycharm提供了一个在新建文件自动生成文件头注释的功能,可以实现自动生成运行环境,作者.日期等必要信息,使用比较方便,配置十分简单. 按照1-5的路径选项即可.在5中填写想要的注释 ...
js 高级注释（模块注释，class注释，函数注释等）
文件注释文件注释位于文件的最前面,应包括文件的以下信息:概要说明及版本(必须)项目地址(开源组件必须)版权声明(必须)开源协议(开源组件必须)版本号(必须)修改时间(必须),以ISO格式表示(可使用 ...

pycharm如何添加文件注释和函数注释

0. Intro

1. 文件注释自动化添加

2. 函数注释、描述添加

3. 查看注释

pycharm如何添加文件注释和函数注释相关推荐

最新文章

热门文章