【Java】Eclipseのコメント自動生成機能

この記事は約3分で読めます。

スポンサーリンク

例えばフィールドに以下のような変数を宣言しているとして

Eclipseのウィンドウ⇒設定⇒Java⇒コード・スタイル⇒コードテンプレート

ここでコメントの設定が出来ます。例えば「コメント」の「>」をクリックして開いた所にある「Getter」をクリックして、右上の「編集」をクリックし、内容を以下のように変更します。

「bare_field_name」とありますが、「変数を挿入」で選択できます。そしてOK⇒適用して閉じるをした後に、先ほどのフィールド変数hogeを選択し、右クリックで「ソース」⇒「getterおよびsetterの生成」をクリックします。

以下の画面で、「メソッド・コメントの生成」にチェックを入れた状態でOKをクリックします。

以下のようなコメント付きのメソッドが作成されます。

「取得」の前の変数名と、@returnの横の「変数名」の所は手動で日本語名を記述しましょう。setterについては何もしていないので上記のようにはなっていないはずですが、同じように設定するだけです。メソッドにもコメントが設定出来ます。今生成したgetterとsetterを削除して、コード・テンプレートの設定画面で先ほどは「コメント」の「>」をクリックしましたが、今度は「コード」の方を開いた所にある「getter 本文」をクリックして 、右上の「編集」をクリックし、以下のように記述しましょう。

そして先ほどと同じ手順でOK⇒適用して閉じる⇒変数右クリック⇒ソース⇒getterおよびsetterの生成をクリックすると、以下のように出力されます。

setterの方のコメント、コードの設定もしてあげて、日本語の変数名を記述してあげて、以下のような形にします。

これで、自動生成されるメソッドについてのコメントの付け方が完了です。コード・テンプレートの「変数名を挿入」の変数名ですが、調べれば何についての変数なのかわかるのでしょうが私はメソッド名を変数名だけわかればいいと思います。

今回は以上です!

スポンサーリンク

コメント

タイトルとURLをコピーしました