美文网首页
doxygen工具小结

doxygen工具小结

作者: 牧晨牧晨 | 来源:发表于2018-06-07 14:31 被阅读0次

    doxygen是一个自动文档生成工具,根据代码里写的注释,自动生成html和latex格式的文档。通常是给c++用的,通常是出html格式的,你看到的pcl网上文档就是拿doxygen生成的。

    事实上,随意一份代码,都可以拿doxygen生成一个文档,然后在本地看它的代码结构。 我们拿以难读著称的lsd-slam举个例子。

    由于你电脑里可能还没有doxygen,我们先来安装一下:    

sudo apt-get install doxygen doxygen-gui【主要是doxygen本体和它的gui模块。我在ubuntu14.04下是这两个包名。如果你不确定,请用apt-cache search doxygen查一下。】

    在该文件夹下开一个doc文件夹,把一会儿生成的文档放里头:

mkdir doc

cd doc

doxywizard【调出gui面板】

首先,建个文件夹,把lsd-slam的代码拷下来:

git clone https://github.com/tum-vision/lsd_slam.git

切到Run,点“Run doxygen",等文档生成完。然后点“show html output",就可以在浏览器里看到文档啦。如果你下一次想直接看,直接打开doc/html/index.html就可以了!

参考 半闲居士博客,非常感谢。

相关文章

  • doxygen工具小结

    doxygen是一个自动文档生成工具,根据代码里写的注释,自动生成html和latex格式的文档。通常是给c++用...

  • doxygen 生成注释文档

    下载工具doxygen ,https://www.doxygen.nl/download.html[https:/...

  • 常用工具集

    软件名作用idm文件下载工具Beyond Compare文件比较工具Doxygen+Graphviz源码文档生成工...

  • Doxygen

    一、Doxygen简介 Doxygen是一个程序的文档产生工具,可以将程序中的注释转换成说明文档或者说是API参考...

  • Doxygen文档生成工具教程

    Doxygen是API文档生成工具,可以根据代码注释生成文档的工具。支持HTML、CHM、PDF等格式。主要支持C...

  • iOS生成代码注释文档

    Today(2015/10/12)在网上搜索iOS对应的文档生成工具也还是Doxygen,HeaderDoc和ap...

  • 学习doxygen 1. 安装与注释风格

    doxygen文档地址:http://www.stack.nl/~dimitri/doxygen/manual/i...

  • Python文档生成工具pydoc

    在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc、doxygen、s...

  • windows安装texlive报错xz: (stdin): C

    因项目需要将注释导出成PDF文档,使用doxygen工具,但是该工具只能到处letex脚本,需要运行脚本生成PDF...

  • iOS生成文档

    Doxygen 官网:http://www.doxygen.org/index.html下载:http://www...

网友评论

      本文标题:doxygen工具小结

      本文链接:https://www.haomeiwen.com/subject/tilgsftx.html