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

Javadocは、Javaソースコード内の特別にフォーマットされたコメントを読み取り、コンパイルされたドキュメントを生成する拡張可能なドキュメント生成システムです。通常、HTML Webページの形式でAPIドキュメントを生成するために使用されます。

2
ジェネリック型パラメーターを文書化するためのjavadocタグはありますか？
Sunのサイトでjavadocのドキュメントを調べて、クラスまたはメソッドのジェネリック型シグネチャを文書化するために使用できるjavadocタグがあるかどうかを探しました。 のようなもの@typeparamで、通常と同様ですが、@paramタイプだけでなくメソッドにも適用できます。 /** * @typeparam T This describes my type parameter */ class MyClass<T> { } そのようなタグはないのではないかと思います-どこにもそれについての言及はありません。JavaSEAPIのドキュメントにはその兆候はありませんが、奇妙な省略のようです。誰かが私を正しく置くことができますか？
165 java  javadoc 
4
Pythonドキュメントでのjavadocの使用[終了]
休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する 私は現在Pythonから始めており、PHPのバックグラウンドが高く、PHPではjavadocドキュメントテンプレートとして使用する習慣をつけています。 Pythonのドキュメンテーションjavadocとしての場所があるのか​​と思っていましたdocstring。ここで確立された規則および/または公式のガイドラインは何ですか？ たとえば、Pythonの考え方に合わせるには手の込んだようなものですか、できる限り簡潔にしようとする必要がありますか？ """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number @param string priority_name priority name @param string message message to display @return string formatted string """ そして、もし私が少し余りに網羅的であるなら、代わりにこのようなものを使うべきです（ほとんどのドキュメントは__doc__メソッドを通じて印刷されません）？ # replaces template place holder with values …
4
Android Studio：ホバーするとJavadocが空になる
私は最近、EclipseからAndroid Studioに移動しましたが、気に入っています。ただし、Eclipseのホバー機能のJavadocがありません。 ここの指示に従って機能を追加しましたが、ホバーにはJavadocが含まれていません。ドキュメンテーションショートカットを使用すると、Ctrl+ Shift+ Spaceドキュメンテーションが正しく表示されますが、ツールチップに表示されます。 以下は、私が見るもののスクリーンショットです。明らかに、このメソッドにはJavadocがあるはずです。 これはすべてのメソッド/変数で見られます。どんな助けでもありがたいです。
7
Android Studioで作成者テンプレートを変更する
AndroidStudioでファイルを作成したときに表示される自動作成者を変更したい。 /** * Created by a556520 on 16/01/14. */ public class POI { 著者は「a556520」を使用しますが、それは私の名前であり、従業員数ではありません。それは可能ですか？設定で見つかりませんでした。
3
javadocコメントを作成するためのIntelliJショートカットキーは何ですか？
Eclipseでは、Alt+ Shift+ Jを押して、フィールド、戻り値、またはその特定のjavadocコメントに適用できるもので自動的に生成されるjavadocコメントを取得できます。IntelliJ IDEAにこの機能があると思います。このためのキーボードショートカットがあるかどうか誰かに教えてもらえますか？
11
Javadocの良い例[終了]
閉まっている。この質問はスタックオーバーフローのガイドラインを満たしていません。現在、回答を受け付けていません。 この質問を改善してみませんか？Stack Overflowのトピックとなるように質問を更新します。 3年前休業。 この質問を改善する Javadocを含むソースファイルの良い例はありますか？ 私はインターネット上でJavadocの良い例をたくさん見つけることができます。それらを作成するために使用される特定の構文を見つけたいと思います。どこかでライブラリのソースを調べられると思いますが、それは大変な作業のようです。
140 java  javadoc 
14
シンプルなゲッター/セッターコメント
ゲッターとセッターにコメントするためにどの規則を使用していますか？これは私がかなり長い間疑問に思っていたものです。例えば： /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ public float getSalary(); 1a / bと2a / bでまったく同じものを書いていることにいつも気づきます。1a）従業員の給与を設定します。1b）従業員の給与を設定します。それはとても冗長なようです。今私はあなたがコンテキストを与えるためにあなたが（a）の部分でより多く書くかもしれないもっと複雑な何かを見ることができました、しかしそこにいるゲッター/セッターの大部分にとって言葉遣いはほとんど正確に同じです。 単純なゲッター/セッターについて、（a）部分または（b）部分のいずれかのみを入力してもよいかどうか、私は興味があります。 どう思いますか？
3
Javadocを使用して列挙値に@リンクする方法
Javadoc 1.5を使用して、列挙値への@リンクを作成できませんでした。 私がしたいことは、このような列挙型を作成することです： public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** * Others we know nothing about. */ OTHERS } そして、次のようなリンクを使用して、EarthのJavadocを参照してください。 {@link Planet.EARTH} 私もその{@link Planet#EARTH}スタイルを試しましたが、役に立ちませんでした。 これがまったく可能かどうか誰でも知っていますか？
120 java  javadoc 
3
Intellij IDEAはjavadocを自動的に表示します
Netbeansでコーディングすると、コードがオートコンプリートされ、Javadocが表示されます。ただし、Intellij IDEAを使用しているときにCtrl+Spaceをクリックするとオートコンプリートが表示され、Ctrl+Qをクリックするとjavadocが個別に表示されます。 Netbeansのように、オートコンプリートが表示されるか、Intellij IDEAでCtrl+Spaceをクリックするたびに、要素のJavadocを表示することは可能ですか？
3
Netbeans：@authorを変更する方法
Netbeans IDEで新しいクラスまたはインターフェースを作成すると、「@ author ....」タグが表示されます。その値を変更するには？可能であれば、いくつかの設定ファイルを編集するのではなく、Netbeansメニューを使用して変更します:) Netbeans 7.2を使用しています
4
JavaDocでの@seeの使用？
@seeJavaDocsを扱うときにいつ使用しますか？その使用法は何ですか？ たとえば場合はMethodA呼び出しがMethodB、私は入れなければならないの@seeでMethodBのjavadocを参照してMethodAそれはそれと呼ばれるものですので、または私はへの参照を配置する必要がありますMethodBからMethodA、それはそれを呼び出しているため。私は@seeOracleのWebサイトで内容を読みましたが、信じられないほど漠然としているように見えます。それは「参照」を意味するが、実際にはそれが何を意味するのかを示していません。
110 java  methods  javadoc 
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.