程序文档工具LogUtils、Vim IDE、Yard、vimrc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:LogUtils(强大的 Android 日志管理器)、Vim IDE(一键化打造 Vim IDE 环境)、Yard(Ruby 文档工具)、vimrc(终极 Vim 配置)。

1、LogUtils(强大的 Android 日志管理器)

LogUtils是一个强大的Android日志管理器,支持对象、List、Map、数组等输出。具有以下特点:

支持直接打印数据集合,如List、Set、Map、数组等。

全局配置log输出。

个性化设置Tag。

准确显示调用方法、行,快速定位所在文件位置。

支持android系统对象Intent、Bundle打印。

提供release-no-op版本。

个性化设置Tag:

程序文档工具LogUtils、Vim IDE、Yard、vimrc介绍

打印数据列表:

程序文档工具LogUtils、Vim IDE、Yard、vimrc介绍

打印数组:

程序文档工具LogUtils、Vim IDE、Yard、vimrc介绍

打印对象本身属性和继承的属性:

程序文档工具LogUtils、Vim IDE、Yard、vimrc介绍

打印系统对象Intent:

程序文档工具LogUtils、Vim IDE、Yard、vimrc介绍

2、Vim IDE(一键化打造 Vim IDE 环境)

程序文档工具LogUtils、Vim IDE、Yard、vimrc介绍

一键化打造 Vim IDE 环境(自动生成头信息,自动补全,自动折叠,自动生成 markdown 目录)。

VIM IDE部署方法:

部署方法很简单:

git clone https://github.com/meetbill/Vim.git

sh start_vim.sh

IDE 功能,如下图所示:

程序文档工具LogUtils、Vim IDE、Yard、vimrc介绍

版本发布更新记录:

[V1.1]:

[V1.1.01] 2018-04-22 修改:使用 pathogen 管理插件,目前插件可以查看插件列表。

V1.0 released:

[V1.0.12] 2017-09-28 增加:Golang 语法高亮。

[V1.0.11] 2017-07-24 修改:状态栏显示。

[V1.0.10] 2017-04-21 增加:Python 代码自动审查(pyflakes)。

[V1.0.09] 2017-04-18 增加:括号自动匹配插件 auto-pairs。

[V1.0.08] 2017-03-18 增加:自动格式化中文排版插件 pangu,更新 TOC 插件。

[V1.0.07] 2016-10-07 增加:Markdown 生成 TOC 插件。

[V1.0.05] 2016-08-26 修改:更新 Ctags,添加 Python 代码自动折叠。

[V1.0.04] 2016-05-29 增加:自动生成 markdown 头信息。

[V1.0.03] 2016-05-18 修订:对 GitHub 文档进行整理。

[V1.0.02] 2014-08-13 新增:对 Vim 进行整理发布一键化程序。

[V1.0.01] 2014-01-01 新增:发布初始版本。

下载地址:https://gitee.com/mirrors/Vim-IDE

3、Yard(Ruby 文档工具)

Yard,是一款 Ruby 文档工具。使用它,你可以在为你的 Ruby app 写文档时预览你的代码。它拥有简单的定制模板,支持你自己的 DSL,并有大量优秀的扩展,而且每天都在增加。

功能:

1].RDoc/SimpleMarkup格式兼容性:使YARD与RDoc格式兼容,实际上,YARD不会对RDoc文档字符串进行任何处理,并将其留给输出生成工具来决定如何呈现文档。

2].Yardoc元标记格式像Python,Java,Objective-C和其他语言一样:YARD对常规标记文档使用meta标签使用'@tag'样式定义语法,这些标签应该能够并排放置RDoc格式的文档,但是提供了一种更加一致和可用的方式来描述有关对象的重要信息,例如它们采用什么参数以及它们期望是什么类型,什么类型的方法。YARD还支持某些标签的可选类型声明。

3].YARD的自定义构造和可扩展性:YARD旨在通过插件进行扩展和定制。YARD还为其他任何地方的可扩展性而设计,使您可以添加对新编程语言,新数据结构甚至数据存储位置/方式的支持。

4].原始数据输出:YARD还可以将记录的对象作为原始数据(转储的命名空间)输出,可以在以后重新加载以进行生成,甚至可以审计代码。这意味着任何开发人员都可以使用原始数据为任何自定义格式(例如YAML)执行输出生成。

5].本地文档服务器:YARD可以为项目或已安装的gem(类似于gem服务器)提供文档,并具有动态搜索和实时重新加载的附加优势。使用实时重新加载功能,您可以记录代码并通过刷新页面立即预览结果,YARD将完成重新生成HTML的所有工作,这使编写文档变得更快。

安装:

要安装YARD,请使用以下命令:

$ gem install yard

(如果要以root用户身份在POSIX系统下安装,请添加sudo)。

另外,如果您直接检查了源代码,则可以从根项目目录调用rake install。

对Debian/Ubuntu用户的重要说明:您的Ruby安装可能缺少RDoc,YARD有时会使用RDoc将标记转换为HTML。如果运行哪个rdoc时显示为空,请通过以下命令安装RDoc:

$ sudo apt-get install rdoc

下载地址:https://gitee.com/mirrors/yard

4、vimrc(终极 Vim 配置)

终极 Vim 配置是一个被良好优化的 Vim 配置,它包含 NERD Tree、文件查找、代码补全、语法检查等多个开发必备的插件,一键安装,省去你到处找各种 Vim 插件的麻烦。

安装:

git clone https://git.oschina.net/eccozhou/vimrc.git ~/.vim_runtime

sh ~/.vim_runtime/install_awesome_vimrc.sh

下载地址:https://gitee.com/eccozhou/vimrc

注明

以上就是程序文档工具LogUtils、Vim IDE、Yard、vimrc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章