ITPub博客

首页 > > > 使用Doxygen把代码文档化

使用Doxygen把代码文档化

作者:liuxuhui 时间:2020-07-07 14:28:01 0 删除 编辑

最近被安利了一款工具,名字叫Doxygen,使用它能把项目的代码和文档导出为HTML、RTF、LATEX等形式,而且还能把代码的组织结构绘制成图,有效减轻阅读大型项目的源码时的困难。

安装Doxygen

Doxygen: Main Page

安装GraphViz

Graphviz - Graph Visualization Software

下面用doxygen的GUI工具DoxyWizard来运行Doxygen,实现对Django的源码进行提取。

配置项目

  1. 选择项目名称,源码目录和文档输出目录。


配置Output


配置diagrams选项


  1. 配置Input选项


配置Dot


  1. 启动doxygen,查看结果。


使用文档

查看命名空间


查看类的继承关系


当然,这只是其中一部分...


查看django.http.response的参考


进入HttpResponse这个类的说明(Doxygen支持Markdown格式的注释)


查看定义


查看函数调用图


查看索引

文件列表


Doxygen支持多种语言(C,C++,JAVA,PHP,Python...),还有许多强大的功能(BUILD,PATTERNS...),麻麻再也不用担心我写文档了!

来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/756/viewspace-3166622/ ,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论

注册时间:2020-06-19

  • 博文量
    583
  • 访问量
    11553