java - Java Android、オブジェクトのメソッド/関数にヒント/説明を付ける

Question

タイトルとして、ユーザーがメソッドまたはオブジェクトにカーソルを合わせると、説明のあるオブジェクトの標準ライブラリのように説明が表示されるように、オブジェクトにヒントまたは説明を配置する方法を教えてください。どこでも検索しましたが、例が見つかりません。

Answer 1

次のような JavaDoc コメントを使用する必要があります。

/**
 * This method returns the x value.
 * 
 * @return the x value
 */
public int getValue()
{
    return x;
}

詳細については、「Javadoc ツールのドキュメント コメントを記述する方法」を参照してください。

Answer 2

これは、JavaDoc を使用して実現できます。

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

上のページの例:

/**
 * 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;
        }
 }

さらに、Eclipse など、これをサポートする IDE が必要です。