Question

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

假设我的类服务器的方法如下所示

@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的方法启动？

Answer 1

从here

复制

@see text |网址| classname | classname＃methodname使用此标记来标记请读者阅读其他相关信息来源。

所以我想它应该是：

/// @see Server#start:

Answer 2

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

通常，我使用函数参考模式

<className>::<functionName>

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

/// \see Server::start

然而，从doxygen手册

对于JavaDoc兼容性，可以在上面的模式中使用＃而不是::

如@ PeterG。的答案所述。

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

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

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

2 个答案: