質問: javaコメントの/ **と/ * 違いは何ですか/** * comment * * */ そして/* * * comment * */ javaで?いつ使うべきですか?
回答: 最初の形式は javadoc です。あなたがjavadocツールによって生成されるあなたのコードのための正式なapiを書いているとき、あなたはこれを使います。たとえば、 java 7 apiページ はjavadocを使用し、そのツールによって生成されました。javadocでよく見られる要素は次のとおりです。 @param:これはどのパラメータがメソッドに渡されているのか、そしてどのような値が期待されているのかを示すために使われます。 @return:これは、メソッドがどのような結果を返すのかを示すために使用されます。 @throws:これは、特定の入力の場合にメソッドが例外またはエラーをスローすることを示すために使用されます。 @since:これは、このクラスまたは関数が利用可能だった最も古いjavaのバージョンを示すために使用されます。 例として、compareのintegerメソッドのjavadocを次に示します。/** * compares two {@code int} values numerically. * the value returned is identical to what would be returned by: * <pre> * integer.valueof(x).compareto(integer.valueof(y)) * </pre> * * @param x the first {@code int} to compare * @param y the second {@code int} to compare * @return the value {@code 0} if {@code x == y}; * a value less than {@code 0} if {@code x < y}; and * a value greater than {@code 0} if {@code x > y} * @since 1.7 */ public static int compare(int x, int y) { return (x < y) ? -1 : ((x == y) ? 0 : 1); } 2番目の形式はブロック(複数行)コメントです。コメントに複数の行を含める場合はこれを使用します。私はあなたが後者の形式控えめにを使いたいだけだと言うでしょう。つまり、method/complex関数がどのような動作をするのかを記述していないブロックコメントでコードに負担をかけたくないということです。javadocはこの2つをよりわかりやすく説明したものであり、それを使用することで実際のドキュメントを生成することができるので、単純なブロックコメントよりもjavadocを使用する方が望ましいでしょう。