@returnとは : JavaA2Z

@return

日本語	戻り値
英語	atmark return
ふりがな	りたーん
フリガナ	リターン

「戻り値」を出力するためのタグ。
Javadocのタグのひとつ。メソッドのドキュメンテーションコメント内に「@return 説明」と記述することで、Javadocによって出力されたメソッドの仕様に、「戻り値 : 説明」という記述が出力される。

参考サイト

Javadoc @return

(KAB-studioからのおしらせです)

// Sample.java
public class Sample
{
    public static void main( String[] args )
    {
        int result = toInt( "100" );
        System.out.println( result );
        // 100
    }

    /**
    *   整数値に変換します。
    *   ↓これ。
    *   @return 変換後の整数値。
    *   @param string 変換前の文字列。"100"とか。
    */
    public static int toInt( String string )
    {
        return Integer.parseInt( string );
    }
}

/*

あとは、javadocコマンドで出力します。

>javadoc -d html src/*.java

この例では、srcディレクトリ内のソースファイルのドキュメントを
htmlディレクトリに出力します。

*/

// Sample.java
public class Sample
{
    public static void main( String[] args )
    {
        int result = toInt( "100" );
        System.out.println( result );
        // 100
    }

    /**
    *   整数値に変換します。
    *   ↓これ。
    *   @return 変換後の整数値。
    *   @param string 変換前の文字列。"100"とか。
    */
    public static int toInt( String string )
    {
        return Integer.parseInt( string );
    }
}


/*

あとは、javadocコマンドで出力します。

>javadoc -d html src/*.java

この例では、srcディレクトリ内のソースファイルのドキュメントを
htmlディレクトリに出力します。

*/