2017-07-10 11 views
3

メソッドを非推奨にしたいと考えています。これは、現在廃止されているいくつかのヘルパーメソッドを呼び出し、現在では廃止されているテストによっていくつかの場所でエクササイズされます。言い換えれば、プロジェクト全体で、同じ廃止予定の一部であり、同時に削除する必要がある、関連するメソッド/クラス/テストのセットがあります。関連する一連のメソッドを非推奨にするためのベストプラクティスは何ですか?

私が後で戻ってきてトップレベルメソッドを削除しようとすると、関連するものがすべて見つかりましたか?明らかに、私は自分のメモをどこかに残しておいて、削除する関連する方法を教えてもらえます。失敗すると、1)エンドポイントを削除する、2)失敗したテストを探して削除する、3)IDEに依存して未使用のメソッドを見つけ出して削除することができますが、エラーが発生する可能性があります。

関連するメソッド/クラス/テストのセットを非推奨にする標準的な方法はありますか?それらはすべて後で同時に削除されますか?

+0

未使用のコードを削除するだけの理由があるのはなぜですか? 未使用のメソッドの一覧を表示できるIDEのプラグインを探すことができます。しかし、標準的な方法は、手動で検索と削除を行うことです。たとえば、Eclipseには、このタイプのジョブに非常に頻繁に使用する「References」メニューがあります。 – tsolakp

+0

廃止予定の一部はパブリックAPIの一部であるため、すぐに削除することはできません。 – Sasgorilla

答えて

3

のベストプラクティスは、タスクを作成

tracking-プロジェクト/問題のいくつかの種類を使用することです(例:JIRA-224)と交換する必要がありますどのような書き込み、どうやって。

は、すべてのメソッドにコメントを追加:

/** 
* method that does nothing 
* 
* @deprecated will be removed in JIRA-224. 
*/ 
@Deprecated 
public void old() { 
// ..... 
} 

準備ができたら、タスクを実行するために割り当てられている人は、すべてのファイルに「JIRA-224」を検索し、メソッドを削除することができます。

+1

私はこれがおそらく短期間で最高の解決策だと思います。 '@ deprecated'コメントの中でトラッカーの問題を参照する限り、削除する必要があるものは簡単に見つかるはずです。長期的には、@DeprecationGroup( "JIRA-224")(もっと一般的には '@SeeIssue(" JIRA-224 ")')という独自のアノテーションを書くことで、 。 – Sasgorilla

0

私は具体的な練習やツールを知っていません。 eclipseなどのツールでは、未使用の専用メソッドの警告を簡単に表示できます。

とにかく、私は単に「メモを取る」ことをお勧めします。意味 - あなたのバグ追跡システムの不具合を開いて、後で削除しようとしているメソッドとテストを単に一覧表示します。だからあなたはあなたの計画の概要を示す単一の場所を持っています。

そして、次のように、未使用の方法について説明するツールがあります。廃止予定のメソッドを削除する前に、ツールを実行するだけです。後で再度実行してから、ツールを再度実行したときに追加された新しいメッセージを処理してください。

2

@java.lang.Deprecatedをメソッドに使用してください。 javadocを忘れてはいけない:

/** 
* Does some thing . 
* 
* @deprecated use {@link #new()} instead. 
*/ 
@Deprecated 
public void old() { 
// ... 
} 
+1

廃止予定のJavadocで代わりに何を使用すべきかを指す良い仕事。人々はこれを離れる/これをあまりにも頻繁に行うことを忘れる。 –

関連する問題