【问题标题】:Is there a negative effect if using @ instead of \如果使用 @ 而不是 \ 是否有负面影响
【发布时间】:2016-09-07 09:52:59
【问题描述】:

我已经使用 doxygen 有一段时间了。我使用的编辑器(N++)为特殊命令创建带有反斜杠的 doxygen cmets。

doxygen 手册说:

文档中的所有命令都以反斜杠 (\) 或 at 符号 (@) 开头。如果您愿意,可以将下面所有以反斜杠开头的命令替换为以 at 符号开头的对应命令。

所以 doxygen 并不真正关心它。 或者导致使用 \ 比使用 @ 更麻烦。

【问题讨论】:

  • 文档说明您可以随心所欲地进行,因此请选择您喜欢的方法并使用它。我使用@ 有一段时间了,从来没有遇到过问题。
  • 除了document之外还有其他工具可以解析javadoc
  • 我看了一下javadoc。 javadoc 专门为标签/特殊命令使用@-signs。
  • 看来@{ 和@} 不等同于\{ 和\}。

标签: doxygen


【解决方案1】:

反斜杠在 C/C++ 中用作转义字符,因此 '\"' 是例如双引号字符。

@ 用于 doxygen 标签可以更轻松地使用 grep / 搜索源代码。

出于这个原因,我总是使用@

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 2023-02-23
    • 2023-04-09
    • 2012-04-20
    • 1970-01-01
    • 1970-01-01
    • 2012-10-06
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多