Javadocで@linkと@seeを使用する

Question

私は実際にjavadocsを書いたことはありませんし、職場のローカルアプリケーション用に書き始めています。それらのほとんどはJavaサーブレットです。私はあまりにも記述的/複雑すぎると思っています。

私はすべてのフォームタイプがブラウザから送信されることに混乱するので、私はそれらをjavadocに含めようとしています。

すべてのサーブレットは、次のカスタムタグを持っている：

tag form.Type:a:"Form types sent from browser:" 

は、ここに1つのprocessRequestのjavadocの例です：

/** 
* Handles requests from browser. 
* 
* @param request 
* @param response 
* @throws ServletException 
* @throws IOException 
* @form.Type initial: Calls {@link org.bcso.com.appearancerequest.html.NotifierHTML#getHTML} if 
* credentials are valid<br> 
* submitRequest: Calls {@see #submitRequest(HttpServletRequest request)}<br> 
* afterEdit: Calls {@link org.bcso.com.appearancerequest.html.AdminHTML#getHTML()}<br> 
* getAdmin: Calls {@link org.bcso.com.appearancerequest.html.AdminHTML#getHTML()}<br> 
* getDeputyAdmin: Calls {@link org.bcso.com.appearancerequest.html.DepAdminHTML#getHTML()}<br> 
* deleteDeputy: Calls {@see deleteDeputy(HttpServletRequest request)}<br> 
* saveOrUpdateDeputy: Calls {@see addOrUpdateDeputy(HttpServletRequest request)}<br> 
* getCourtAdmin: Calls {@link org.bcso.com.appearancerequest.html.CourtAdminHTML#getHTML()}<br> 
* saveOrUpdateCourt: Calls {@see addOrUpdateCourt(HttpServletRequest request)}<br> 
* deleteCourt: Calls {@see deleteCourt(HttpServletRequest request)}<br> 
* getReports: Calls the {@link org.bcso.com.appearancerequest.html.ReportsHTML#getHTML()}<br> 
* reportByDate: Calls {@see getReportByDate(HttpServletRequest request)} <br> 
* reportByDeputy: Calls {@see getReportByDeputy(HttpServletRequest request)}<br> 
* reportByRequestor: Calls {@see getReportByRequestor(HttpServletRequest request)}<br> 
* saveNoShow: Saves data concerning a deputy who no-shows via {@link org.bcso.com.appearancerequest.util.DatabaseUtil#saveNoShow(javax.servlet.http.HttpServletRequest)} 
* and generates an email via {@see sendNoShow(int deputyId, int notificationId)} to admin.<br> 
* reviewLogin: Calls {@see #reviewerLogin(Map user)}<br> 
* 
*/ 

私はこの権利をやっていますか？より良い方法がありますか？

Answer 1

この量のdocはあまりにも大きくないと思います。このフォーマットはHow to Write Doc Comments for the Javadoc Toolの例とは非常に異なりますので、フォーマットを検討する必要があります。

submitRequestおよびdownからの変数がrequestに属しているか、responseに入力する必要があるかどうかは不明です。また、ドキュメントの{@link}と{@see}は同じ効果を作り出します。私はあなたがなぜいくつかの場所で、他の場所で他を使用するか分からない。

私の観察。