栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Python

使用doxygen来从源码产生文档

Python 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

使用doxygen来从源码产生文档

使用doxygen来从源码产生文档

什么是Doxygen

Doxygen 是从带注释的 C++ 源代码生成文档的事实上的标准工具,但它也支持其他流行的编程语言,
如 C、Objective-C、C#、PHP、Java、Python、IDL(Corba、Microsoft 和 UNO/OpenOffice 风格) ),Fortran、VHDL
以及在某种程度上D.

打开doxywizard.exe来产生脚本 1选择doxygen运行的路径 2 设置工程名字与版本号,logo图标 3 选择要扫描的源码路径 4 选择生成路径 5 选择是否添加子目录 与扫描的源代码类型 6 设置HTML输出 7 设置产生diagram 8打开Expert栏

选择HTML,勾选GENERATE_HTMLHELP,选择HHC_LOCATION为
C:Program Files (x86)HTML Help Workshop下的hhc.exe
如果GENERATE_HTMLHELP 标记设置为 YES,则 doxygen 生成三个额外的 HTML 索引文件:index.hhp、index.hhc 和 index.hhk。
index.hhp 是一个项目文件(project file)。
HTML Help Workshop 包含一个编译器,即hhc.exe(html help compiler)可以将 doxygen 生成的所有 HTML 输出转换
为单个编译的 HTML 文件 (.chm)。编译后的 HTML 文件现在用作 Windows 98 帮助格式,并将在未来所有 Windows
平台上替换旧的 Windows 帮助格式 (.hlp)。
压缩的 HTML 文件还包含索引、目录,您可以在文档中搜索单词。

三种文件简介
1.hhp文件,这是最常用的一类文件,它实际上是“HTML Help project”的缩写,表示HTML帮助文件项目,它是生成CHM文件最直接用到的一类文件,
  只需要有一个hhp文件就可以根据它来编译相应的CHM文件。 

2.hhc文件,它是“HTML Help table of contents”的缩写,表示的是HTML帮助文件的目录,通常我们在
CHM文件浏览器的左边窗口中看到的目录内容就由它来提供,当然,它并不能直接被编译成CHM文件,而先要集成到某一hhp文件中才能发挥作用。 

3.hhk文件,它是“HTML Help Index Keyword”的缩写,为我们提供了CHM文件的关键字索引查询功能,
也是一个易于查看的帮助文件不可缺少的一部分,同hhc文件一样,它也不能直接编译生成相应的CHM文件。 
打开Run栏,点击运行,等待运行完成。实际是用doxygen.exe 配合生成的脚本来完成 输出结果
在HTML输出文件夹下即可看到chm类型(chm是compiled HTML file )的文件
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/280577.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号