• paip. c++ doxygen 文档工具的使用以及跟QT CREATOR的集成


    paip. c++ doxygen 文档工具的使用以及跟QT CREATOR的集成


    作者Attilax ,  EMAIL:1466519819@qq.com 
    来源:attilax的专栏
    地址:http://blog.csdn.net/attilax




    doxygen 文档例子:
    /
    /**
     @file
     @brief   like 360 start menu button
     @note     详细注释
    @bug  arg timer ,should hook window
    @todo heyeug hookwind yaozwl .
    @author  attilax <1466519819@qq.com>
     @date c925
     


    文件头注释@file
    //
    因为文件不在任何东西里面,所以不能像类、函数等在上方放注释,只能用@file方式定义,其格式如下,一般@file后面为空,表示本文件.
     




    2、简要注释和详细注释
    ///
    @brief    简要注释 
     @note     详细注释
     
     
     3.类,函数注释
     ///
      类,函数注释分别写在  类,函数的上方就好..
     
     



    4.3.5   类成员变量定义示例

    只在头文件的定义处进行简要注释,不要详细注释。可以在
    上方用/** @brief some brief description */
    或右方用///< some brief description
    (1)在成员变量上面加注释的格式
    /** 成员变量描述 */ 
    int  m_Var; 
    (2)在成员变量后面加注释的格式
    int  m_color;     /**< 颜色变量 */ 


    5.跟QT CREATOR的集成
    //
    QT CREATOR>>tool>>external>>config ,,加了个D:/doxygen/bin/doxygen.exe 参数"D:\doxygen\bin\Doxyfile4c++.cfg"但是,..不执行..提示doxygen.exe 在执行,实际不执行...使用个process monitor查看累挂..doxygen.exe没见执行..好像QT有BUG了


    只好建立了个.bat....在把这个C:\Documents and Settings\Administrator\桌面\c920\doxygen.bat加到个扩展里面.走ok兰..




    qt的扩展实际保存地址是 C:\Documents and Settings\Administrator\Application Data\QtProject\qtcreator\externaltools\*.xml
    虽然也修改这个QtCreator.ini文件了,不过是根据externaltools\*.xml自动生成
    C:\Documents and Settings\Administrator\Application Data\QtProject\QtCreator.ini
    OverrideCategories\SpecialEmptyCategoryForUncategorizedTools\1\Tool=doxygen
    OverrideCategories\SpecialEmptyCategoryForUncategorizedTools\2\Tool=New_Tool
    OverrideCategories\SpecialEmptyCategoryForUncategorizedTools\3\Tool=attilaxc925 






    参考
    doxygen注释语法(一):JavaDoc注释风格、文件头和类注释 - 可乐鸡翅 - 博客频道 - CSDN.NET.htm
    Doxygen详细介绍 - Timmy_zhou的专栏 - 博客频道 - CSDN.NET.htm
    Doxygen - 老孙的博客 - 博客频道 - CSDN.NET.htm
    使用doxygen为C C++程序生成中文文档(上).htm
    Doxygen簡介.htm
     
  • 相关阅读:
    SpringCloud
    Linux
    SpringBoot
    秒杀系统设计
    设计模式
    数据库(mysql)
    Java web
    c#常用控件及简写
    C#常用的form窗体属性(最大化、最小化、窗体居中)
    C#中使用IndexOf()判断字符串在字符串数组中第一次出现的索引位置
  • 原文地址:https://www.cnblogs.com/attilax/p/15199520.html
Copyright © 2020-2023  润新知