zoukankan      html  css  js  c++  java
  • linux(Fedora) doxygen 的安装和使用

           doxygen 是一种功能强大的代码文档化工具,被Boost、OpenCasCade等诸多项目作为文档生成的不二人选

           它有一套规范的代码注释标准,如果开发人员在代码中使用这种标准,就能够通过Doxygen方便地生成html/Pdf等格式的文档,界面非常规范美观。

    Linux Doxgen 可以在这里下载:http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc


    1.安装方法:

    我的电脑的下载路径为:主文件夹--下载。

    下载完成之后在terminal输入指令:

        1.tar xvfz 下载/doxygen-1.7.5.1.src.tar.gz

        2.cd doxygen-1.7.5.1

        3../configure

        4.make

        5.make install


    2.生成配置文件

    打开terminal

        cd进入工程目录

        Doxygen -g生成配置文件

    生成的这个配置文件是用来让用户设置工程的基本属性的。


    3.程序文档生成

    打开terminal

        doxygen    your-cfg-filename

        your-cfg-filename是配置文件名。

        这样就能够生成html格式的文档,可以查看MainPage/Classes/Files,界面非常友好!


    4.注释规范与examples

           在Doxygen的安装目录下可以看到example文件夹,给出了Doxygen的注释规范。比如:


    5.官方指南

    Doxygen Manual

    http://www.stack.nl/~dimitri/doxygen/manual.html

  • 相关阅读:
    性能
    .Net 平台下的互联网架构新思考
    bootstrap-paginator 分页插件笔记
    HTTP 报文中的 Header 字段进行身份验证
    .NET简单企业应用
    djngo快速实现--使用Bootstrap
    Knockout应用开发指南
    Linux下OpenCV的环境搭建(转)
    初识树莓派(转)
    网络名词解释
  • 原文地址:https://www.cnblogs.com/johnpher/p/2570608.html
Copyright © 2011-2022 走看看