Question

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

所有评论都是以下形式：

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

在项目中大约20个中，只有5个出现在Todo List页面中。我无法发现任何明显的模式，除了所有做出现的模式都在“成员”部分（一些未出现的模式也在成员函数中，但我可以'弄清楚他们为什么不出现）。我希望所有@todo评论都会显示在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注释不会被添加到Todo列表中 - 就像评论中提到的用户'doxygen'一样（谢谢）。

但是，既然我理解为什么某些@todo评论没有出现，我对完整的Todo列表和我的问题的渴望仍然存在......

有没有办法配置doxygen，以便它添加所有@todo条评论，无论它们在Todo列表中的位置？

Answer 1

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

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

和

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

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

doxygen todo list正在丢失/遗漏一些todo评论

1 个答案: