前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Doxygen文档系统简单使用

Doxygen文档系统简单使用

作者头像
Qt君
发布2019-07-15 15:23:32
7900
发布2019-07-15 15:23:32
举报
文章被收录于专栏:跟Qt君学编程跟Qt君学编程

按照规范的格式注释源代码,用工具处理注释过的源代码产生文档.便于代码和文档保持同步,可以对文档做版本管理.

注释风格

代码语言:javascript
复制
/**
 *  ...多行注释...
 *
 */

/** ...单行注释... */

文件注释

代码语言:javascript
复制
/**
 * @file xxx
 * @author xxx
 * @version xxx
 * @date xxxx/xx/xx
 *
 * @section LICENSE
 *
 * Copyright(c) yyyy-yyyy XXX
 * All rights reserved
 * 
 * @brief xxx
 */

函数注释

代码语言:javascript
复制
/** 
 * @brief xxx
 * @param[in] param1 param2
 * @param[out] param1 param2
 * @return xxx
 * @retval true success
 * @retval false failed
 */

一般简易注释

代码语言:javascript
复制
/**
 * @brief xxx
 */
本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2019-02-05,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 Qt君 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 注释风格
  • 文件注释
  • 函数注释
  • 一般简易注释
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档