Android Studioでjavadocコメントを生成する方法


204

Androidスタジオでショートカットキーを使用してjavadocコメントを生成できますか?

そうでない場合、javadocコメントを生成する最も簡単な方法は何ですか?


この質問は50/50です。ドキュメント全体でjavadocを生成する単一のjavadocブロックを探すこともできません。どっち?
K-SOの毒性が高まっています。

ALTR + ENTERは、すでに宣言されているメソッドのコメントを生成できるビューを表示します。
Zala Janaksinh 2016年

ライブテンプレート(Androidスタジオ-設定-エディター-ライブテンプレート-追加)を追加する必要があるかもしれません。テンプレートのテキストフィールドに次のテキストを追加します。/ ** * $ comment $ * /
ジョネット・マシュー2017

回答:


388

javadocコメントを生成するためのショートカットが見つかりません。ただし/**、メソッド宣言の前に入力してEnterキーを押すと、javadocコメントブロックが自動的に生成されます。

詳細については、こちらをお読みください。


7
これがクラスやフィールドなどのjavadocコメントを生成するのにも機能しないのは残念です。カスタマイズ可能なテンプレートからjavadocを生成したほうがよいでしょう。
Ted Hopp、2015年

23
もちろん、ショートカットがあります:メソッド/コンストラクター名に位置付けし、Alt + Enterキーを押して、メニューから「javadocの生成」を選択します
Ewoks

上記のソリューションについてこれを参照してください
Pritesh Vishwakarma

110

コメントを生成する/**には、メソッド宣言の前にキーを入力してを押しEnterます。javadocコメントを生成します。

例:

/**
* @param a
* @param b
*/

public void add(int a, int b) {
    //code here
}

詳細については、リンクhttps://www.jetbrains.com/idea/features/javadoc.htmlを確認して ください


4
@satheeshwaran-本当に?例があることを除いて、DouOからの回答(元の回答)と同じです。リンクでさえコピーです。例は、元の回答に追加されている必要があります。
CJBS 2015年

3
@satheeshwaran -何それの価値のために、私は1つはすぐに答えを望んでいるときだけ(の答えで)コメントの例を見てすることは、有用であることがわかります;-)
CJBS

実際の例では、最後の/前に*を欠い
マキシアンブロジーニ

35

ここでOracleのJavadocコメントの例

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
        try {
            return getImage(new URL(url, name));
        } catch (MalformedURLException e) {
            return null;
        }
 }

基本フォーマットは、次のいずれかの方法で自動生成できます。

  • メソッドの上にカーソルを置き、/**+ と入力します。Enter
  • メソッド名にカーソルを置き、Alt+ を押しEnterます> [JavaDocを追加]をクリックします ここに画像の説明を入力してください

17

JavaDocプラグインは、[設定]-> [プラグイン]-> [リポジトリの参照]からインストールできます。

以下のリンクからプラグインのドキュメントを入手してください

JavaDocプラグインドキュメント

ここに画像の説明を入力してください


これはうまくいきます。(上記のように)JavaDocのプラグインをインストールし、その後、プレスCNTL +のSHIFT + ALT + G.
アラン・ネルソン

10

「ドキュメントコメントを修正」を通じて、JavaDocコメント生成のEclipseスタイルを使用できます。「設定」->「キーマップ」を開き、必要なキーに「ドキュメントコメントを修正」アクションを割り当てます。


9

ここでは、このようなことができます。また、ショートカットを使用する代わりに、クラス/パッケージ/プロジェクトレベルで「デフォルト」のコメントを書き込むことができます。要件に従って変更します

   *** Install JavaDoc Plugin ***



     1.Press shift twice and  Go to Plugins.
     2. search for JavaDocs plugin
     3. Install it. 
     4. Restart Android Studio.
     5. Now, rightclick on Java file/package and goto 
        JavaDocs >> create javadocs for all elements
        It will  generate all default comments.

利点は、コメントブロックを作成できることです all the methods at a time.


9

IDEのオートコンプリート機能を使用して、Javadocコメントを自動的に追加できます。入力/**してEnterを押すと、サンプルのJavadocコメントが生成されます。

 /**
 *
 * @param action          The action to execute.
 * @param args            The exec() arguments.
 * @param callbackContext The callback context used when calling back into JavaScript.
 * @return
 * @throws JSONException
 */

5

Android Studioではプラグインは必要ありません。Macでは、Android Studioを開くだけです->上部バーでAndroid Studioをクリックします-> Prefrencesをクリックします->リストからファイルとコードテンプレートを検索します->インクルードを選択します->ビルドしますすべてのプロジェクトで持続します


2
  • java docsコメントを追加するもう1つの方法は、Ctrl + Shift + Aを押して 、ポップアップを表示します>>タイプ:javadocsを追加>> Enter

  • Ctrl +シャツ+ A:コマンド検索(オートコンプリートコマンド名)

ここに画像の説明を入力してください


2

メソッド名を選択(クリック)し、Alt + Enterキーの組み合わせを使用して、「JavaDocを追加」を選択します。

これは、メソッドの上にまだコメントを追加していないことを前提としています。そうでない場合、「JavaDocの追加」オプションは表示されません。


2

Androidスタジオでは、コメントを自動生成する方法がいくつかあります。

  • 方法I:

/ **と入力してEnterを押すと、次のコメント行が生成され、パラメーターなどが自動生成されますが、このチェックアウトメソッドIIのホットキーが必要な場合は、以下を参照してください。

  • **方法II:**

1-トップメニューに移動

2-ファイル>設定

3-設定からキーマップを選択します

4-右上の検索バーで「Fix Doc」を検索します

5-結果から「修正ドキュメントコメント」を選択し、ダブルクリックします

6-ダブルクリックした後、開いたドロップダウンからキーボードショートカットを追加を選択します

7-キーボードのショートカットキーを押す

8-コードに移動し、コメントを追加する場所にショートカットキーを押します

9-お楽しみください!


ドキュメントを追加する最も説得力のある方法。たとえば、「」を割り当て、ショートカットとしてEnterを
押しました

1

キーマップ設定でEclipseバージョンのキーキャップを選択するだけです。EclipseキーマップはAndroid Studioに含まれています。


0

質問を完全に理解しているとは思いませんが、キーボードショートカットのリストはここにあります。


2
日食でjavadocコメントを追加するにはAlt + Shift + jを押しますが、AndroidStudioでは方法がわかりません
qinxianyuzou 2013年

私が覚えているとしたら、そのショートカットは「jautodoc」プラグインをインストールして有効にした場合にのみ機能しました。
Matt

0

Android Studio-> Preferences-> Editor-> Intentions-> Java-> Declaration-> Enable "Add JavaDoc"

また、実装するメソッド(Ctrl / Cmd + i)を選択すると、左下にチェックボックスが表示され、JavaDocをコピーできるようになります。



-5

ALT+ SHIFT+ Gは、メソッドの自動生成されたコメントを作成します(メソッドの開始位置にカーソルを置きます)。


public void hideKeyboard()uカーソルをpublicの前に置いて試してみるか、スタジオにJavaドキュメントをインストールしたかどうかを確認してください。
Dinesh IT

それも私のために働いていません。たぶん、それはいくつかの特別なキーマップで働いています。キーマップは、[設定]> [キーマップ]で設定できます。または、キーマップが編集されました。
Oliver Kranz
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.