Doxygen文档

原创 2003年12月25日 10:28:00
 

Doxygen文档<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

ZhangRui@landwind.com.cn

Doxygen可以为C++, C, Java, IDL (Corba and Microsoft flavors) PHPC#生成文档

大致用途有三:

  1. 可以生成一个在线html文档或者一个离线的LATEX格式文档也支持RTF(MS-Word) PostScript, hyperlinked PDF, compressed HTML, Unix man pages多种格式生成。文档直接由源码生成,这使得保持文档和代码一致性更加轻松。

  2. 可以配置doxygen从无文档的源码中提取代码结构。这就便于在大型源码中迅速上路。也可以将这些不同元素间的关系使用图形表达出来,包括依赖图,继承图和collaboration图,这些都是自动生成的。

  3. 甚至可以使用它来生成平常的文档,例如手册

DoxygenLinux下开发,但高度可移植,可运行在各种平台之下。

这个手册包括下面三个部分,每个部分分为以下几个章节

第一部分是用户手册

第二部分是参考手册

第三部分文档是为开发者准备的:

第一章:出发吧

程序doxygen是分析源码和生成文档的。可以参考Doxytag usage了解详细的使用方法。只是在没有源码时,所以需要生成对外部文档的引用时(例如doxygen所生成的文档),使用Doxytag

下图展示如何工具间的关系和工具间信息的流程

ns3使用doxygen生成离线api文档

doxygen的维基介绍: Doxygen是一个编写软件参考文檔的工具。该文檔是直接写在源代码中,因此比较容易保持更新。Doxygen可以交叉引用文檔和源代码,使文件的读者可以很容易地引用实际的源代码...
  • zy416548283
  • zy416548283
  • 2014年08月05日 10:39
  • 3879

用Doxygen为objective-c代码生成文档

从xcode3升级到xcode4后,那一堆Header Doc选项没了 xcode3的Header Doc加命令行方式生成的文档是基于注释的,而且逻辑整理功能很薄弱。 Doxygen很强大,1.7...
  • u013660421
  • u013660421
  • 2014年04月14日 10:40
  • 827

使用doxygen生成注释文档——visual studio

前期准备:代码注释。 这里介绍两个方法: 一.安装插件 1. 安装GhostDoc插件。(建议设置快捷键为shift+Alt+j) 2. 回到vs界面规范注释规则。 Tools->GhostDoc->...
  • index_cqq
  • index_cqq
  • 2016年03月22日 16:48
  • 2236

使用doxygen生成注释文档——eclipse

因为工作需要,研究了几天doxygen的用法。心血来潮想着以博客的形式记录下来忘记的时候还能回顾哈~ 前期准备:代码注释。 团队项目的话,方便起见也为了统一风格,建议直接导入配置信息文件,步骤如下:...
  • index_cqq
  • index_cqq
  • 2014年06月30日 18:26
  • 819

如何用doxygen生成文档

Doxygen是一款基于源代码生成文档的工具,类似于Java中的javadoc. 概念:文档和注释的区别 文档(Documentation) 是给代码的使用者准备的,或者是更高一级的开发...
  • hitlion2008
  • hitlion2008
  • 2013年03月07日 21:05
  • 8388

利用doxygen生成python文档

On and off I have been developing a little Python module to provide KP-ABE and CP-ABE functionality ...
  • carolzhang8406
  • carolzhang8406
  • 2015年11月09日 14:22
  • 1529

使用Doxygen生成全中文的chm帮助文档

下载和安装 Doxygen到 Doxygen 官网 下载最新的Doxygen安装程序,然后安装。这个软件包包括了一个GUI界面的前端工具,可以帮助我们方便创建Doxygen配置文件和生成目标文档。下...
  • xzytl60937234
  • xzytl60937234
  • 2017年04月22日 15:55
  • 717

Doxygen生成注释文档

概述:  Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。注释的语法与Qt-Do...
  • tuwenqi2013
  • tuwenqi2013
  • 2017年04月11日 13:27
  • 964

Xcode快速Doxygen文档注释 — 简明图文教程(3分钟后爽歪歪)

首先要下载这个服务  这是一个老外写的工作流,解压缩,然后双击,安装一下,  选择xcode  -- services --services perference  安装完就会在右边的菜单...
  • muzhenhua
  • muzhenhua
  • 2015年05月05日 15:24
  • 655

doxygen将头文件生成html文档

前段时间公司里做项目要求遵循doxygen文档规范,并且在Windows XP下安装了Doxygen 1.8.4版本,使用起来能查看头文件是否遵循doxygen规范和一些简单的错误,另外还可以根据C或...
  • suifengpiao_2011
  • suifengpiao_2011
  • 2016年05月11日 17:07
  • 904
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Doxygen文档
举报原因:
原因补充:

(最多只允许输入30个字)