タグ付けされた質問 「javadoc」

@linkタグを使用してメソッドにリンクするにはどうすればよいですか？ 変わりたい： /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return baz */ public Baz fooBarBaz() に： /** * Returns the Baz object owned by the Bar object owned by Foo owned by …

864 java  hyperlink  javadoc 

何かのようなもの： /** * See {@linktourl http://google.com} */

768 java  url  javadoc  hyperlink 

メソッドのJavadocコメントに含めたい小さなコード例があります。 /** * -- ex: looping through List of Map objects -- * <code> * for (int i = 0; i < list.size(); i++) { * Map map = (Map)list.get(i); * System.out.println(map.get("wordID")); * System.out.println(map.get("word")); * } * </code> * * @param query - select statement * @return List of Map …

531 java  html  javadoc 

メソッドのドキュメント本文からメソッドの1つ以上のパラメーターへの参照を追加する方法はありますか？何かのようなもの： /** * When {@paramref a} is null, we rely on b for the discombobulation. * * @param a this is one of the parameters * @param b another param */ void foo(String a, int b) {...}

313 java  arguments  javadoc 

私はMavenを使用しているので、不完全なJavadocタグ（たとえば、欠落しているパラメーター）があるローカルリポジトリプロジェクトにビルドしてインストールすることができました。 ただし、Java 8（1.8.0-ea-b90）に移行したので、Mavenはドキュメントタグの欠落に厳格であり、Javadocがないプロジェクトをビルドまたはインストールしようとすると、Javadocの問題に関連する多くのJavadocエラーが表示されます「完璧」。ローカルリポジトリにコンパイルしてインストールしようとしているプロジェクトの一部は、私が制御できないサードパーティのプロジェクトです。したがって、これらのすべてのプロジェクトですべてのJavadocを修正するという回避策は、私のシナリオでは実行可能ではないようです。 これはmvn clean package install、プロジェクトで実行したときに表示される出力の一部です。 [INFO] ------------------------------------------------------------------------ [INFO] BUILD FAILURE [INFO] ------------------------------------------------------------------------ [INFO] Total time: 9.026s [INFO] Finished at: Mon Apr 08 21:06:17 CEST 2013 [INFO] Final Memory: 27M/437M [INFO] ------------------------------------------------------------------------ [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9:jar (attach-javadocs) on project jpc: MavenReportException: Error while creating archive: [ERROR] Exit …

312 java  maven  migration  java-8  javadoc 

Eclipse用の新しいバージョンのADT r17プラグインには、JAR依存関係を自動的にセットアップする機能が追加されました。/ libsフォルダー内のすべての.jarファイルがビルド構成に追加されます。残念ながら、Android Dependenciesクラスパスコンテナーは変更できません。 自動的に挿入された.jar（/ libsフォルダーから）にjavadocとソースを添付するにはどうすればよいですか？

254 android  eclipse  adt  javadoc 

現在、私はこのJavadoc構文で他のクラスのメソッドを参照しています： @see {@link com.my.package.Class#method()} そして、私がドキュメントから理解していることでは、これはこれを行う正しい方法です。しかし、今面白い部分、またはイライラします。このjavadocを生成すると、まず次のエラーが発生します。 warning - Tag @see:illegal character: "123" in "{@link com.my.package.Class#method()}" warning - Tag @see:illegal character: "64" in "{@link com.my.package.Class#method()}" warning - Tag @see: reference not found: {@link com.my.package.Class#method()} これの生成されたHTMLコードは次のとおりです。 "," <code>com.my.package.Class#method()}</code> "," そしてもちろん私にはリンクがありません。誰が何が起こっているのか、そしてこれを修正する方法についてのヒントはありますか？ ASCIIテーブルによれば、woldの文字123および64は{および@を表すので、ドキュメントに従ってこの構文が正しい場合、これらの文字はなぜ有効ではないのでしょうか。

238 java  javadoc 

パッケージレベルのJavadocコメントを作成する場合、推奨される方法は何ですか。職業はなんですか？ package-info.java 長所 新しい 短所 クラスの乱用-クラスはコメント用ではなくコード用です package.html 長所 HTML拡張はそのコードではないことを意味します IDE /テキストエディターでの構文の強調表示 短所 なし？ 私は常にPackage.htmlを使用してきました。しかし、私はそれが正しい選択かどうか疑問に思っています。

230 java  javadoc 

Androidスタジオでショートカットキーを使用してjavadocコメントを生成できますか？ そうでない場合、javadocコメントを生成する最も簡単な方法は何ですか？

204 android-studio  javadoc 

違いは何ですか /** * comment * * */ そして /* * * comment * */ Javaで？いつ使うべきですか？

190 java  comments  javadoc 

誰かがjavadoc @seeとの違いを教えてもらえ{@link}ますか？ どちらを使用するのですか？

184 java  javadoc 

私はそれが最も重要な問題ではないことを知っていますが、アノテーションの前後にjavadocコメントブロックを配置できることに気づきました。コーディング標準として何を採用したいですか？ /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after the annotation */ private MyOtherClass other; }

184 java  coding-style  annotations  javadoc  code-documentation 

Java APIでは、パッケージのJavadocコメントを見ることができます。 パッケージを文書化するためにJavadocコメントをどこにどのように配置しますか？

182 java  packages  javadoc 

@javadocでシンボルをエスケープするにはどうすればよいですか？{@code}タグの内側にあるタグの内側で使用しようとしてい<pre>ます。 すでにHTMLエスケープ@シーケンスを試しましたが、うまくいきませんでした。

180 java  escaping  javadoc 

私はMaven（およびMaven Eclipse Integration）を使用して、EclipseでJavaプロジェクトの依存関係を管理しています。MavenリポジトリからのJARファイルの自動ダウンロード機能は、リアルタイムセーバーです。残念ながら、APIドキュメントとソースコードは含まれていません。 ソースとjavadocの添付ファイルを自動的に取得してEclipseに正しく登録するようにMavenを設定するにはどうすればよいですか？

176 eclipse  maven-2  javadoc