1

Objective-C iOS プロジェクト内で doxygen を使用していますが、すべての@todoコメントが Todo リスト ページに追加されません。

すべてのコメントは次の形式です。

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

プロジェクトの約 20 のうち、Todo リスト ページに表示されるのは 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 リストに表示されませんが、他の 2 つのコメントは表示されます。someMethodの宣言とヘッダーからの宣言を削除するとotherMethod、それらの宣言は表示されません。その@todoため、文書化されていないメソッド (文書化されていないフレームワークからオーバーライドされたメソッドを含む) のコメント、プライベート メソッド、および@todo特定の文書化されたエンティティに関連しない一般的なコメントは、Todo リストに追加されません。ありがとう）。

しかし、一部のコメントが表示されない理由@todoが分かった今でも、完全な Todo リストが欲しいという欲求と疑問はまだ残っています...

@todoTodo リストのどこにあるかに関係なく、すべてのコメントを追加するように doxygen を構成する方法はありますか?

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 に答える