doxygen待辦事項列表正在丟失/缺失一些待辦事項評論

我在Objective-C iOS項目中使用了doxygen，並且沒有將所有@todo評論添加到待辦事項列表頁面。doxygen待辦事項列表正在丟失/缺失一些待辦事項評論

所有的評論的形式是：

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

出的項目約20個，只有5個在待辦事項列表頁面顯示出來。除了出現在之外的所有內容都出現在「成員」部分中（某些不出現的部分也在成員函數中，但我無法弄清楚它們爲什麼會出現不出現）。我預計所有@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中的那個在Todo List中，但另外兩個呢。如果我從標題中刪除someMethod和otherMethod的聲明，則不會顯示它們。因此@todo在未記錄的方法（包括從未記錄的框架覆蓋的方法）中的註釋，私有方法和一般@todo與特定記錄實體無關的註釋不會被添加到Todo列表中 - 就像用戶'doxygen'在評論（謝謝）。

然而，現在我明白爲什麼一些評論@todo沒有出現，我的一個完整的待辦事項列表渴望和我的問題依然存在......

有什麼辦法來配置doxygen的，這樣它增加了所有@todo評論無論他們在哪Todo List？

來源

2012-07-12 jhabbott

你能提供一個@todo項目不出現的案例的最小例子嗎？請注意，待辦事項必須是某些內容（即成員，接口，文件，全局變量等）的一部分。如果你認爲你發現了一個bug，最好在doxygen的bug追蹤器中提交一個bug報告。 – doxygen 2012-07-12 20:45:57

這很難做，因爲我看不到明顯的模式，但我會放棄它。我不認爲這是一個錯誤 - 這可能是我不明白如何正確使用它。當你說它需要成爲某些文檔的一部分時，這是否意味着我不能僅僅將todos放在一個沒有記錄的功能中，比如'/ ** @todo在bar工作時，用下面一行代替foo */'？ – jhabbott 2012-07-13 10:09:02

@doxygen我現在想做的事似乎不可能，我該如何添加功能請求（而不是bug）？ – jhabbott 2012-07-22 12:39:00

嘗試你想與您的評論的目標代碼之前將您的意見：

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

和

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

代碼中的註釋應該被忽略。

來源

2012-07-16 19:41:40 Simulant

問題是：「是否有任何方法來配置doxygen，以便它添加所有@todo註釋，而不管它們在Todo List中的位置？」 – jhabbott 2012-07-22 11:17:40

doxygen待辦事項列表正在丟失/缺失一些待辦事項評論

回答

相關問題