Question

我正在为某些C ++代码编写doxygen注释。我有两个功能：

/** Some existing doxygen comment */
int foo(int x);

/** Another existing doxygen comment */
int foo(
    this_signature y1,
    is_really_long y2, 
    and_to_be_honest y3, 
    i_would y4, 
    really_rather y5, 
    avoid_repeating_it y6);

/** This is what I'm writing now */
int foo(double z);

在第二个函数的doxygen注释中，我想引用@ref指向第二个函数，或者更确切地说是该函数的第二个变体。我该怎么做呢？

注意：我特别（不是唯一地）对一个不会很冗长的解决方案感兴趣（考虑到第二个函数的长签名）。

Answer 1

（如@Scheff所写）可以通过签名进行引用。像这样：

/** Fie to show reference:
  *
  * \ref foo(unsigned long)
  *
  * \ref foo(unsigned long y)
  */
void fie(void);

另请参阅http://www.doxygen.nl/manual/autolink.html#linkfunc。

关于长签名的评论，可以使用@Scheff建议的\anchor可能性，尽管在我看来，起初它看起来是一个很好的解决方案，但维护性较差（当存在时检查签名变体是否存在）文档已生成，但\ref的{{1}}中的字符串不是（并且您可能需要类似\anchor的字符串，否则（\ref my_anch "foo(unsigned long y)"）链接的名称为\ref my_anch。

如何@ref相同方法的其他变体？

1 个答案: