Javaでコードをコメントする最良の方法

Question

Javaでコードをコメントするには、Eclipseで関数名とパラメータを自動的に生成する方法がありますか？

たとえば、私は手動でそれらのコメントを足すよ：

// <summary> 
// Some comments about the function 
// </summary> 
// <param name="id">the user ID</param> 
// <param name="username">The user password</param> 
// <returns></returns> 
public Connect(int id, String password) 
{ 

} 

おかげで、既に。

Answer 1

私は個人的にはコメントのためにJAutodocプラグインを使用することを好みます。それを見てみましょう。それは良いです。

Answer 2

のJavadocを簡単にEclipseで生成することができJavadoc

を見てみましょう。 /**と入力すると自動完成します。また、javadocを自動的に生成するようにコードテンプレートを設定することもできます。

Answer 3

一緒にあなたはコメントをする対象の方法を選択し、SHIFTを押して、ALTとJ。

JavaDocについて学ぶ時間があれば、コードを文書化するための非常に豊富な領域です。

Answer 4

あなたが質問に表示されたものではなく、Javadocのコメント形式を使用するのが最善の方法です。 Eclipseで

、メソッド名の上にカーソルを置き、Ctrlキー + Altキー + Jを押してください。すべてのパラメータがリストされたJavadocコメントが生成されます。 >設定 - - > Javaの - >コードスタイル - >コードテンプレート - >

Answer 5

コメントのJavaDocとEclipseを使用することですが、コードが組み込まれています最善の方法

また、Javadocコメントがウィンドウに生成される方法を制御することができますちょうどそれを行うためのテンプレート。

ここに示したフォーマットを使用する場合は、独自のテンプレートを作成できます。テンプレート機能を使用すると、変数を挿入できます。そのうちの1つがメソッド名になります。

Answer 6

あなたは、宣言の行にカーソルを有する同一時間にCTRL +ALT +Jを押す必要があります。

Answer 7

私はJavaでコードをコメントアウトするための最良の方法は、あなたのメソッドや変数名に意味のある名前を提供することであると言うだろう:)

class MyService { 
    public void authenticateUser(int userId, String userPassword) {...} 
} 

Answer 8

慣例で、これはそれを行う方法です：

/** Some comments about the function 
    * 
    * @param id the user ID 
    * @param username The user password 
    * 
*/ 
public Connect(int id, String password) 
{ 

} 

もしあなたのメソッドが何かを返すならば、あなたは `@return 'とそれに続く説明を追加します。

IDEと標準のJavaDocツールでこれを解析できます。

Answer 9

このスレッドには多少の混乱があるようです。私はJavadocコメントを生成するために使用するキーシーケンスはSHIFT +ALT +JないCTRLのですか？