用doxygen生成lua接口文档

关注+星标公众号，不错过精彩内容来源|简书编排 |strongerHuang程序员的很多文档，特别是有代码的文档，绝大部分都是由一款文档生成工具【Doxygen】生成。什么是Doxygen?Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达...

Doxygen生成的HTML会放到out目录下，生成的HTML如下图所示。HTML界面上面我们配置了一些选项，也成功生成了HTML文档。我们希望下次代码改动后能够继续沿用上次配置，那么我们可以把这些配置保存成Doxyfile文件，如下图所示。保存Doxyfile配置文件有了配置文件后我们完全可以通过命令行来生成API文档，假设配置文件名为Doxyfile，那么我们只需要执行doxygen /path/to/Doxyfile即可生成API文档。

写C代码时，用惯了doxygen，现在写lua代码，也特别地希望用doxygen，上官网看了看，真发现有lua的filter git clone https://github.com/alecchen/doxygen-lua.git 这个源即可获取，不过貌似人家没有管Windows什么事，perl脚本，所有东西都是Linux的 好在我们有cygwin，在cygwin中安装上perl和doxyg...

Ldoc是一个类似doxygen的文档生成工具，doxygen功能更强大但是不支持lua语言，所以需要专门的Ldoc工具来编写Lua文档：https://github.com/stevedonovan/LDoc在官方的README.md页面中对安装过程描述很含糊，以至于弄了不少时间（真不知道是自己理解能力有问题还是他们表达能力有问题，无语）。不过，我发现程序员应该知道自己要装的工具用来做什么的。比如

自动生成接口文档 一、开头 开发的小伙伴应该会遇到这个问题吧！ 项目设计阶段写的接口文档，需求的不断的改动，导致前期定义的接口已面目全非。如果没有及时更新接口文档，那么这些接口文档对前端开发人员将是一场灾难！由于项目紧急，是没有时间完善接口文档，我们该如何提高前后端的开发效率呢？ 解决方案一：项目集成 Swagger 插件，前端人员访问 Swagger 生成的接口文档，查看和使用接口。 解决方案二...

程序员的很多文档，特别是有代码的文档，绝大部分都是由一款文档生成工具【Doxygen】生成。 什么是Doxygen? Doxygen 是一个程序的文件产生工具，可将程序中的特定批注转换成为说明文件。通常我们在写程序时，或多或少都会写上批注，但是对于其它人而言，要直接探索程序里的批注，与打捞铁达尼号同样的辛苦。 大部分有用的批注都是属于针对函式，类别等等的说明。所以，如果能依据程序本身的结构，将批注经过处理重新整理成为一个纯粹的参考手册，对于后面利用你的程序代码的人而言将会减少许多的负担。不过，反过来说，整.

基于 DoxyGen 插件生成 程序 帮助 文档 效果预览： HTML 帮助文档 CHM 帮助文档 这个 还是 需要 写代码 的 时候 更加规范 才可以，不然 文档 估计 也是 没法看了！哈哈哈！ 环境 安装 配置 各种插件 工具 下载 集合 ：下载传送地址 提取码：zqdv 下载解压 后 如下图 ： c# 文件夹 是 DoxyGen 关于 常见 编程语言的 工具集！ 包括 c / c++ / C# / java 等… Lua 文件夹 是 lua文档 相关的 工具集… 在这篇文章 中 只会

doxygen 1.11.0 使用详解（三）——开始

LDoc 是一款专为 Lua 语言设计的文档生成工具，旨在为 Lua 开发者提供高效、灵活的文档生成解决方案。LDoc 最初是为了满足 [Penlight](https://github.com/lunarmodules/Penlight) 项目的文档需求而开发的，并且依赖于 Penlight 库。LDoc 的设计目标是与 [LuaDoc](https://keplerproject.github...

1． 安装LuaForWindows这个lua工具可能很多人都装了，测试方法，cmd打开后输入lua回车，产生如下界面即已经安装1.1 将lua的安装目录配置到path环境变量中。如Lua默认安装，目录为C:\Program Files(x86)\Lua\bin;Windows菜单中右键计算机-》属性-》高级系统设置-》高级-》环境变量-》path里面最后添加 C:\Program Files (...

Doxygen常用标签命令关键字

创建连接命令 @addindex (text) 添加1文本到latex索引中 @anchor 放置一个不可见的已命名的anchor(固定点)到文档中，且能使用@ref命令进行引用。 注意：anchor目前只能放置在一个标记成页面(使用@page)或主页(使用@mainpage)的注释块中 @cite 增加一个书籍参考到一个文本和数目参考列表里。 @endlink 终止一个命令@link开始的连

目录 一、默认配置生成 二、自定义配置生成（推荐） 1）项目基础设置 2）Expert设置 2.1 Project 2.2 Build 2.3 input 2.4Source Browser​ 2.5 HTML 2.6 Dot 3 Run 点击运行即可 一、默认配置生成 选择要生成说明文档的代码，其所在的目录 使用默认配置生成： 查看生成的输出结果： ...

团队的代码习惯一直不好，注释五花八门，甚至几千行代码没有一千行注释。几个新进来的成员纷纷抱怨，痛定思痛，决定来一次大刀阔斧的改变。     由于本部门团队编写接口的时候比较多，做接口说明文档也是本分内的事情，既能规范注释，又方便编写文档，于是想到了Doxygen这个神器，也决定使用Doxygen的注释规范。     说实话，几年前接触过这个东西，但仅仅玩了下就给扔掉了，并没有深入，这次玩发现不

可以跑轻量级的网页脚本语言 javascript , 同时支持跑lua脚本语言。做了个单片机上跑的网页串口屏，打破只有电脑能跑网页的古老问题，