【问题标题】:How to insert the project name in a comment in doxygen?如何在 doxygen 的评论中插入项目名称?
【发布时间】:2016-02-17 08:11:42
【问题描述】:

我写的cmets中经常使用项目名。但是,到目前为止,我对其进行了硬编码。现在我意识到,如果要更改项目名称,我将不得不检查所有文档部分并进行更改。所以想问问能不能简单的在评论中引用项目名,让doxygen以后填写。

/*! \brief This is the main function of the (project_name) project
*/
int main()
{
    return 0;
}

【问题讨论】:

  • 也许看看 ALIASES 来定义你自己的命令,使用环境变量或固定名称在评论中使用。
  • 我已经尝试过了,但它似乎不起作用(请参阅 MattOnyx 答案下方的 cmets)

标签: c++ doxygen


【解决方案1】:

我认为您正在寻找的是环境变量,您可以阅读有关here 的信息。 您正在寻找的应该是$(PROJECT_NAME)。 要使用它,请参阅this answer。

【讨论】:

  • 如果我将它插入到注释块中,$(PROJECT_NAME) 将被忽略。
  • 我也尝试过使用别名:projectName=$(PROJECT_NAME)。但这也没有效果。如果我改为尝试:projectName=test,则别名命令有效。所以也许是PROJECT_NAME 环境。变种。没有在正确的时间解决?
  • 你设置PROJECT_NAME = "MY PROJECT NAME"你的doxygen配置文件了吗?
  • 是的。或者更准确地说,doxygen-wizard 为我做了。否则,我猜它也不会显示在生成的 html 中,如果这被破坏了。
  • 我不会参考非常古老的手册,而是参考官方的 doxygen 站点:doxygen.org 可以找到当前手册和当前章节 stack.nl/~dimitri/doxygen/manual/config.html
猜你喜欢
  • 2012-09-07
  • 1970-01-01
  • 1970-01-01
  • 2011-06-22
  • 2011-11-04
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2012-06-26
相关资源
最近更新 更多