在 Vim 中自动生成 Python 函数注释文档

最新推荐文章于 2023-01-10 09:13:15 发布

laobingm

最新推荐文章于 2023-01-10 09:13:15 发布

阅读量832

点赞数

分类专栏： python 文章标签： vim python pydocstring

本文链接：https://blog.youkuaiyun.com/laobingm/article/details/96362298

版权

python 专栏收录该内容

3 篇文章

订阅专栏

Pydocstring - Python文档字符串的生成器

能够自动生成函数文档注释、类文档注释，包含以下功能。

原仓库地址
 查看效果图

用法

将光标移动到 def 或 class 关键字所在行，在命令模式中输入 :Pydocstring 并按下回车键，就可以看到文档字符串模板出现在当前行的下方，会根据已有的代码规则自动识别包含函数名、参数类型、参数以及返回值类型。

关键映射

如果要更改默认键映射（输入指令打印注释串），可以在.vimrc中设置以下内容实现自定义的目的。

nmap <C-_> (pydocstring)

函数文档效果图
指定参数和返回值的类型
相关文档: https://python3-cookbook.readthedocs.io/zh_CN/latest/c07/p03_attach_informatinal_matadata_to_function_arguments.html

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

laobingm

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

专栏目录

【驯服野生verilog-mode全记录】day3 —— 基于vim自动生成verilog-mode格式初始文件模板

moon9999的博客

09-07

1192

如果能在创建verilog文件时直接生成verilog-mode的初始模板，那么就进一步节省了RTL的编码量，本篇博客就是阐述如何实现这一功能，思路和技巧参考了很多vimrc的配置技巧。

使用Sphinx为你的python模块自动生成文档

preyta的专栏

06-23

2万+

Sphinx是一个可以用于Python的自动文档生成工具，可以自动的把docstring转换为文档，并支持多种输出格式包括html，latex，pdf等。安装 pip install sphinx

参与评论您还未登录，请先登录后发表或查看评论

github php doc.vim,vim 中自动生成 python 函数注释文档 - 基于 Pydocstring

weixin_39979245的博客

03-26

188

Pydocstring - Python文档字符串的生成器能够自动生成函数文档注释、类文档注释，包含以下功能。插入一行文档字符串插入多行文档字符串插入评论这个插件深受 phpdoc.vim和sonictemplate.vim的启发。原仓库地址：https://github.com/heavenshell/vim-pydocstring效果图：https://github.com/heavenshe...

在 VIM 中注释掉整段代码的方法

为祖国健康工作50年

03-14

1153

在 VIM 中注释掉整段代码的方法：例如，要注释以下3行 Python 代码： def say_hello(): print 'hello world!' return None 1, Ctrl + V 进入 VIM 的块操作模式. 2, 使用 j, k 键上下移动，选中这三行，需要确保每行的首列包含在选中块中。 3, 键入 I (大写 i)，即在行首插...

vim+Doxygen实现注释自动生成

bodybo的专栏

12-01

7275

借鉴文章：https://www.cnblogs.com/zzqcn/p/4660615.html 为自己的代码写好注释是一个良好的习惯，而编写Doxygen风格的注释更是可以通过doxygen工具为代码自己生成文档，非常好用。DoxygenToolkit（https://github.com/vim-scripts/DoxygenToolkit.vim）就是这样的一个插件。Doxyge

vim 按F4自动生成注释

weixin_43539379的博客

07-17

209

map ms:call AddAuthor()‘S function AddAuthor() let n=1 while n < 11 let line = getline(n) if line=~’[#]\s*\s*\SLast\smodified\s*:\s*\S*.*$’ call UpdateTitle() return endif let n = n + 1 endwhile i...

Vim插件：vim-pydocstring自动生成Python源码文档字符串

vim-pydocstring是一个专门为Vim编辑器设计的插件，它支持自动生成Python代码的文档字符串（docstrings）。文档字符串是Python代码中用于描述模块、函数、类或方法功能的字符串，它以三引号（'''或"""）包围，位于...

DoxygenToolkit.vim：简化C，C ++，Python中的Doxygen文档

02-28

总的来说，DoxygenToolkit.vim是Vim用户在C，C++，Python项目中提高文档编写效率的好帮手。通过其丰富的功能和易用的接口，它帮助开发者更专注于代码逻辑，而不是文档的格式和细节，从而提升了整体的开发体验。

Vimdoc工具：自动生成Vim插件的帮助文档

Vimdoc是一个工具，它可以解析标记在Vim脚本源代码中的特殊注释，并自动生成符合Vim帮助文件标准的文档。首先，我们需要理解什么是Vim脚本（vimscript）。Vim脚本是Vim编辑器的脚本语言，它允许用户通过编写脚本来...

vim自动生成文件模板 templates 设置方法

03-11

在Vim中，模板是一种预先定义好的文本结构，当我们创建新文件时，可以根据所选模板自动插入特定格式的代码或文档框架，避免手动输入重复内容。这对于编写规范化的代码或文档非常有帮助。设置Vim模板的方法主要包括...

对一个vim 函数的详细注释。

hjjdebug的专栏

12-09

4747

对我而言，这是一个复杂的函数，虽然详细注释，但还是有些难懂，注释也是参考原作者的。我只是简单的整理了一下。将注释添加到了函数中，方便阅读理解。函数功能，能够自动对齐赋值运算符的位置。查找，替换是核心目的。（调试通过） function! AlignAssignments () "Patterns needed to locate assignment o...

python模块大全doc_Python文档生成工具pydoc使用介绍

weixin_39795268的博客

11-24

424

在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc.pydoc是Python自带的模块，主要用于从python模块中自动生成文档，这些文档可以基于文本呈现的、也可以生成WEB 页面的，还可以在服务器上以浏览器的方式呈现！【用法】Windo...

API文档自动生成工具apiDoc

songer44的博客

06-02

1085

简介随着移动客户端的流行，后端系统需开放越来越多的 API 来供客户端使用。API文档的编写和管理是一个挑战，随着API不断变化，文档必须及时更新，但编写文档也是个不小的负担。一个比较好的做法，就是将文档放在代码里，开发人员编写代码时同时修改文档。然后通过工具从代码中抽出文档，并生成方便用户阅读的格式。此类工具早已存在，比如Java中的javadoc。这里我们要介绍一个非常轻量级的，适用于几乎所有流行语言的，针对Restful API的文档自动生成工具－apiDoc。官网安装 apiDoc基于Nod

飘逸的python - 代码即文档docstring

热门推荐

mattkang

07-10

2万+

什么是docstring在软件工程中，其实编码所占的部分是非常小的，大多是其它的事情，比如写文档。文档是沟通的工具。在python中，比较推崇在代码中写文档，代码即文档，比较方便，容易维护，直观，一致。代码写完，文档也出来了。其实Markdown也差不多这种思想，文本写完，排版也完成了。看看PEP 0257中对docstring的定义： A docstring is a string

vim - Pydocstring - Python文档字符串的生成器

xinfeng205的博客

01-27

491

1.1 Pydocstring 具有以下功能插入一行文档字符串插入多行文档字符串插入评论原仓库地址：效果图： 1.2 用法将光标移动到 def 或 class 关键字所在行，按下 ctrl + l 或在命令行输入Pydocstring，就可以看到文档字符串模板神奇地出现在当前行下方。 1.3 关键映射更改默认键映射，在.vimrc中设置以下内容: nmap` <silen...

vim如何快速注释一段代码

weixin_42596246的博客

01-10

1331

在 vim 中，你可以使用 Ctrl + V 进入 Visual Block 模式，然后按上下移动键选择要注释的代码块。接下来，你可以使用 Shift + I 进入插入模式，然后在代码块的第一行输入注释符号(如 #)。最后，按 Esc 退出插入模式即可。例如，对于以下 Python 代码： def hello(): print("Hello, world!") hello() 你可以...

python pydoc-文档生成工具(汇总tcy)

tcy-阿春

09-08

1652

pydoc-文档生成工具 2018/9/8 ------------------------------------------------------------------------------ 1.1.用途：是python自带的一个文档生成工具，使用pydoc可以很方便的查看类和方法结构 python中pydoc模块可以从python代码中获取docstring，然后生...

python生成word目录_python代码docstring生成文档之sphinx

weixin_39631316的博客

11-25

251

在使用python中，我们一般在模块，类，函数下使用docstring添加字符串说明性文档，使开发人员更好的可以看懂此代码是做什么用的。然而写了那么多的注释，我们想要一篇文档怎么办，第一种办法不可能将写完的注释直接手动的ctrl+c ctrl+v的，此时sphinx就出现了，解决了这一问题。要想使用它，首先得需要安装它，安装方式：pip install sphinx安装完成之后，在主项目下创建d...