使用 Doxygen 使用 @see 命令引用特定的类方法答案

【问题标题】：Reference a specific class method with @see command using Doxygen使用 Doxygen 使用 @see 命令引用特定的类方法
【发布时间】：2012-04-14 13:35:04
【问题描述】：

我无法使用 doxygen @see 命令引用特定的类方法。

假设我有一个类 Server，其方法如下所示

@interface Server : NSObject

- (void) start:(NSInteger) mask;

@end

假设我有另一个类，它有一个 Server 对象。

@interface RandomNumberGeneration

/// How can I reference the method start from 
/// class server using the command @see
/// @see ????
+ (NSInteger) generate;

@end

那么，有没有办法引用Server类的start方法呢？

【问题讨论】：

标签： objective-c doxygen documentation-generation

【解决方案1】：

复制自here

@见文字 |网址 |类名 | classname#methodname 使用它来标记向读者推荐其他相关信息来源。

所以我猜应该是：

/// @see Server#start:

【讨论】：

+1 获取博客文章的链接 - 将 doxygen 与 Objective-C 结合使用的精彩介绍。
似乎对我不起作用。这最近有变化吗？使用 Xcode 5
参加聚会已经很晚了，但请确保您使用 @see 定位的方法附有 doxygen 文档。我的 @see 链接在我将文档添加到所指向的方法之前不起作用。

【解决方案2】：

有关引用类和函数的更多信息，请参阅 doxygen 手册页 Automatic link generation。特别是参见“函数链接”部分。

通常，我使用函数引用模式

<className>::<functionName>

所以在你的情况下，我会使用

/// \see Server::start

但是，来自 doxygen 手册

为了与 JavaDoc 兼容，可以使用 # 代替上述模式中的 ::

如@PeterG. 的回答中所述。

为了完整起见，请注意，如果您引用同一类中的成员

在包含成员 foo 的类的文档中，使用 ::foo 对全局变量进行引用，而 #foo 将链接到该成员。

【讨论】：