生成されたJavadocに表示されるドキュメントコメントの一部を除外する方法

Question

このプロジェクトでは、API javadocsを作成します。ドキュメンテーションのコメントでは、メソッドの詳細は別として、履歴の詳細を書きたいと思います。たとえば、特定の問題を修正するためにメソッドが変更された場合、そのメソッドのjavadocコメントと共に問題の詳細を文書化する必要があります。

/** 
* Displays the details for a valid registered customer against the specified <code>Integer customerId</code>.<br> 
* Responsible to check the existance of the customer before sending back the information for the "Customer Reference" screen. 
* 
* @param customerId the customer id to fetch the details for 
* @return <code>jsp</code> file name for "Customer Reference" screen along with Customer details 
* 
* BTS-1947 | custom fields not displayed correctly | 25-10-2016 | Vaibhav 
*/ 
public String displayCustomerInfo(Integer customerId) { 

問題があり、我々はのJavadocツールで生成されたのJavadocに参加BTS-1947 | custom fields not displayed correctly | 25-10-2016 | Vaibhavを表示したくありません。それを行うことは可能ですか、javadocを使用して更新履歴を維持するためのより良い方法はありますか？

Answer 1

jdk1.7を使用している場合は、カスタムタグを使用できます。 javadocがコンパイルされると、カスタムタグで何も表示されません。それはあなたに警告を与えるでしょう。たとえば ：

/** 
* Displays the details for a valid registered customer against the specified <code>Integer customerId</code>.<br> 
* Responsible to check the existance of the customer before sending back the information for the "Customer Reference" screen. 
* 
* @param customerId the customer id to fetch the details for 
* @return <code>jsp</code> file name for "Customer Reference" screen along with Customer details 
* 
* @custom BTS-1947 | custom fields not displayed correctly | 25-10-2016 | Vaibhav 
*/ 
public String displayCustomerInfo(Integer customerId) { 

jdk1.8は、カスタムタグでJavadocをコンパイル中にエラーが発生します。

ご希望の場合は、お知らせください。