按照规范的格式注释源代码,用工具处理注释过的源代码产生文档.便于代码和文档保持同步,可以对文档做版本管理.
/**
* ...多行注释...
*
*/
/** ...单行注释... */
/**
* @file xxx
* @author xxx
* @version xxx
* @date xxxx/xx/xx
*
* @section LICENSE
*
* Copyright(c) yyyy-yyyy XXX
* All rights reserved
*
* @brief xxx
*/
/**
* @brief xxx
* @param[in] param1 param2
* @param[out] param1 param2
* @return xxx
* @retval true success
* @retval false failed
*/
/**
* @brief xxx
*/