我的团队开始使用 doxygen 记录我们的 C 代码，特别关注我们的公共 API 标头。doxygen 中似乎有很多灵活性和不同的特殊命令，这很棒，但如果没有反复试验，就不清楚什么是好事，什么是坏事。
您最喜欢的标记代码的方式是什么？您必须做什么和不应该做什么？
请提供您的重要提示，每个答案一个，以方便投票。
我希望定义 API 文档的整个方法，包括提供一个模板来让团队的其他成员开始。到目前为止我有这样的事情：
/**
* @file example_action.h
* @Author Me (me@example.com)
* @date September, 2008
* @brief Brief description of file.
*
* Detailed description of file.
*/
/**
* @name Example API Actions
* @brief Example actions available.
* @ingroup example
*
* This API provides certain actions as an example.
*
* @param [in] repeat Number of times to do nothing.
*
* @retval TRUE Successfully did nothing. …我把哈德森的大工作分成了小工作.作业A执行主构建,作业B执行另一个具有不同配置的构建.我已经配置了Hudson,因此A触发B并且工作正常,问题是作业A具有原始构建号并且B从1开始.
我的问题是:是否可以以某种方式将BUILD_NUMBER环境变量从作业A传递给作业B？构建编号用于构建工件名称,因此在工件之间匹配数字会很好.
谢谢.