web-dev-qa-db-ja.com

@todoプログラミングを管理する方法は？

長年、私のコードはこの種のコメントでいっぱいでした：

//TODO : Add ...
...
/*
 *TODO : Fix ...
 *
 */

今、私は自分で作成すると思います @todo javadocアノテーション...しかし、その前に、todoプログラミングのものを管理するためのより良い方法があるかどうかを知りたいですか？

javajavadocproject-management
23
wj.

あなたのIDE（Eclipse、NetBeans、..）には、すべてのTODOsを検出してリストに表示するタスクプラグインがあります。EclipseではWindow > Show View > Other > Tasks

独自の注釈を書く必要はありません。

48
Bozho

TODOステートメントは、コード内に永久に残るリスクを伴います。これは、// TODO elaborate answer

35
Daniel Daranas

基本的に、TODOアイテムの種類ごとに3つのシステムを使用します。

  • 短期間のアイテム（今日や今週など）用の紙のメモ帳
  • TODOコメントに加えて、IDEサポート（例：Eclipseタスクビュー）
  • Trac plus IDE support（e.g Mylyn）などのトラッカーを使用して、より複雑な長期アイテムをサポート
12
Fabian Steeg

Vimの場合、これも Tasklist スクリプトで、Eclipseのタスクリストに触発されており、テキストファイル内のTODO、FIXMEなどをスクレイピングし、追加のバッファーにリストとして表示します（ スクリーンショット ）。

5
catchmeifyoutry

多分Doxygenがあなたを助けることができますか？

Doxygenはそれらの/// @ TODO：を認識し、それらでリストを作成します。

そして、DoxygenはJavadocスタイルのコメントを使用できるので、試してみるのは簡単だと思います。

4
Johan

@todo javadoc注釈は使用しません。これは、IMOがドキュメントに含まれるべきではないためです。
ドキュメントはpublicである必要があり、TODOには理想的ではありません。
TODOは、関連するコードの近くにも置く必要があります。これは、コメントを使用する利点です。

4
user85421

通常の// todoなどの小さなタスクの場合はEclipse Mylynでローカルタスクを使用し、大きなタスクの場合は（機能やバグと呼ばれる可能性があると思われる場合でも）Tracを使用します。コードにTODOが満載されている場合は、チケット管理システムを入手してください。

2
Alberto Zaccagni

Mavenを使用している場合は、 taglist-maven-plugin を使用してソースファイルをスキャンし、タグ（必要なタグはすべて設定可能です）をスキャンして a report を生成できます。彼らの出現に。

タグリストMavenプラグインは、@todoタグや//TODOタグなど、コード内にあるさまざまなタグに関するレポートを生成します

ただし、タグの追跡は簡単な部分であり、タグの修正は少し難しく、時間がかかります:)

2
Pascal Thivent

多分あなたはあなたのプロジェクトでそれらのキーワードを検索するためにfindとgrepを使うことができます

2
ZelluX

todoフラグの問題は警告の場合と同じです（例Javaコンパイラ、チェックスタイル）。頻繁に表示される場合は無視します。この場合は、ビルドシステム（例：mavenまたはant）各反復の終わりに、ToDoフラグの数が減少するという規則を作成する必要があります。

todo-flagsが少ないということは、次のことを意味します。

  • それらを解決する
  • 古くなったので削除してください（コードを片付けなかった場合に頻繁に発生します）

通常、すべてのタスクにtodoフラグを使用しないでください。私にとって、それらは単なるリマインダーまたはリファクタリング-todosです。大きなタスクは常にチケットシステム（tracやjiraなど）で追跡する必要があります。

2
manuel aldana

私はFIXを使います！ TODOの代わりに。感嘆符の数は優先順位を示します。 IntelliJを使用すると、これらのカスタムフィルターを設定できるため、レベル3の「FIX !!!」を見ることができます。コメントし、それらに取り組みます。

2
Sam Barnum

あなたのTODOステートメントがあなたをそれほど悩ませ、それらを見るときあなたにそれだけの不安を引き起こしているなら、私はコンパイルを検出して失敗するビルドプロセスで小さなスクリプトを書くでしょう。警告文で失敗するのと同じ方法で失敗します。

1
wheaties

TODOは小さなチームで問題ありませんが、オープンソースプロジェクトまたは開発者アクセスを何らかの方法で拡大する場合、TO_DO、fixme、XXX、NOTE、HACK、バグ、「your_defect_tool_here」などの他のバリアントはとにかくスキャンする必要があります。少し重いですが、私のTODOプロトコルは次のようになります。

TODO：yy-mm-dd：author：your_comment

最後に、設計のステートメントや意見ではなく、戦略的に残すコメントを作成します。

0
Conrad B