1

我在 Objective-C iOS 项目中使用 doxygen，它没有将所有@todo评论添加到 Todo List 页面。

所有评论的格式如下：

/** @todo Thing that needs to be done described here */

在项目中的大约 20 个中，只有 5 个出现在 Todo List 页面中。除了确实出现的所有模式都在“成员”部分中之外，我找不到任何明显的模式（一些没有出现的模式也在成员函数中，但我不知道为什么它们不出现' t 出现）。我希望所有@todo评论都会出现在待办事项列表中，无论它们在代码中的什么位置。

更新： 我一直在尝试一个最小的类......

TodoTestClass.h：

#import <UIKit/UIKit.h>

@interface TodoTestClass : UIViewController

- (void)someMethod;
- (void)otherMethod;

/** @todo add a method to do foo */

@end

TodoTestClass.m：

#import "TodoTestClass.h"

@implementation TodoTestClass

- (void)viewDidLoad
{
    [super viewDidLoad];
    /** @todo do stuff here */
}

- (void)someMethod
{
    /** @todo document and implement someMethod */
}

/**
 This does some other stuff
 */
- (void)otherMethod
{
    /** @todo implement otherMethod */
}

@end

@todo标题中的注释和其中的注释viewDidLoad不会出现在待办事项列表中，但其他两个会出现。如果我从标题中删除和声明someMethod，otherMethod它们都不会出现。因此@todo，未记录的方法（包括从未记录的框架覆盖的方法）中的注释、私有方法和@todo与特定记录实体无关的一般注释不会被添加到待办事项列表中——就像用户在注释中提到的“doxygen”一样（谢谢）。

然而，既然我明白了为什么没有出现一些@todo评论，我对完整待办事项列表的渴望和我的问题仍然存在......

有什么方法可以配置 doxygen 以便将所有@todo评论添加到待办事项列表中，而不管它们在哪里？

4

1 回答 1

0

尝试将您的评论放在您要针对您的评论定位的代码之前：

/** @todo add a method to do foo */ 
@interface TodoTestClass : UIViewController

和

/** @todo do stuff here */
- (void)viewDidLoad`
{
    [super viewDidLoad];
}

代码中的注释应该被忽略。

于 2012-07-16T19:41:40.710 回答