Android Studio でショートカット キーを使用して javadoc コメントを生成できますか?
そうでない場合、Javadoc コメントを生成する最も簡単な方法は何ですか?
Android Studio でショートカット キーを使用して javadoc コメントを生成できますか?
そうでない場合、Javadoc コメントを生成する最も簡単な方法は何ですか?
javadoc コメントを生成するためのショートカットが見つかりません。ただし/**
、メソッド宣言の前に入力して Enter キーを押すと、javadoc コメント ブロックが自動的に生成されます。
詳細については、これをお読みください。
コメントを生成する/**
には、メソッド宣言の前に key と入力して を押しEnter
ます。javadoc コメントを生成します。
例:
/**
* @param a
* @param b
*/
public void add(int a, int b) {
//code here
}
詳細については、リンク https://www.jetbrains.com/idea/features/javadoc.htmlを確認してください。
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;
}
}
基本フォーマットは、次のいずれかの方法で自動生成できます。
"Fix doc comment" を使用すると、Eclipse スタイルの JavaDoc コメント生成を使用できます。「設定」->「キーマップ」を開き、「ドキュメントコメントを修正」アクションを必要なキーに割り当てます。
ここで、このようなことができます。また、ショートカットを使用する代わりに、クラス/パッケージ/プロジェクト レベルで「デフォルト」のコメントを書くことができます。そして、要件に従って変更します
*** 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.
メソッド名を選択 (つまりクリック) し、Alt+Enter キーの組み合わせを使用して、[JavaDoc の追加] を選択します。
これは、メソッドの上にまだコメントを追加していないことを前提としています。追加していない場合、[JavaDoc を追加] オプションは表示されません。
キーマップ設定でキーキャップの Eclipse バージョンを選択するだけです。Android Studio には Eclipse キーマップが含まれています。
私たちのほとんどは を使用しているため、プラグインを使用してKotlin
JavaDoc (KDoc) を生成できます。Android Studio で開き( + +を押します)、選択して検索します。KDoc-erをダウンロードしましたが、どれでも選択できます。その後、Android Studio を再起動します。Settings
CtrlAltSPlugins
kdoc
任意のクラス/メソッドを見つけて、 と入力/**
し、 を押しEnterます。次のような短い説明が表示されます。
/**
* User data
*
* @property name
* @property avatar
* @property gender
* @constructor Create empty User data
*/
class UserData(...
ALT+ SHIFT+Gは、メソッドに対して自動生成されたコメントを作成します (カーソルをメソッドの開始位置に置きます)。