問題タブ [javadoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
6 に答える
209 参照

oop - メソッド宣言のすぐ上に置いたドキュメントの正しい用語は何ですか?

私はホワイトペーパーを書いていますが、定義の宣言の前にコメントブロックとして配置する内部ドキュメントの種類の正式な用語が何であるかわからないことに気付きました。

最終的にJavaDocメンバーのドキュメントになるのと同じこと。

これは単なる内部ドキュメントではなく、「ヘッダードキュメント」が適切な用語であるかどうかはわかりません。

特定の言語(Java / Perlなど)に固有の用語ではなく、一般的な用語を探していることに注意してください。

0 投票する
1 に答える
1744 参照

java - IntelliJ IDEA 用の Ghostdoc のようなプラグイン

私は年をとって怠け者になりました。私の C# 作業では、Roland Weigelt の優れたVisual Studio 用のGhostDocプラグインにかなり依存するようになりました。

IntelliJ IDEA で動作する Java 用の同様のプラグインを知っている人はいますか?

0 投票する
1 に答える
1976 参照

xml - Checkstyle の PackageHtml-rule は package-info.java を無視します

私は checkstyle を使ってコードを分析しています。有用なルールは、パッケージに Javadoc の説明が含まれているかどうかをチェックする PackageHtml です。ただし、新しい Java バージョンでは、package.html の代わりに package-info.java を使用することをお勧めします。問題は、checkstyle が package-info.java を無視し、ルール違反を報告することです。package-documentation をチェックし、package.htmlとpackage-info.javaを受け入れるように checkstyle を構成するにはどうすればよいですか?

0 投票する
3 に答える
20846 参照

java - JavaDocを使用してJava列挙型を文書化する最良の方法は何ですか?

自分のプロジェクトで Java の列挙型を使い始めたばかりで (仕事で JDK 1.4 を使用する必要があります)、列挙型に JavaDoc を使用するベスト プラクティスについて混乱しています。

この方法は機能することがわかりましたが、結果のコードは少し洗練されていません。

列挙型宣言をコンマで連鎖せずに独自の行で分割する方法はありますか、またはこれが列挙型に JavaDoc を使用するための最良の方法ですか?

0 投票する
19 に答える
49460 参照

java - 作成するすべてのメソッドにJavadocを使用していますか?

すべてのJavaメソッドのドキュメントコメントを書く必要がありますか?

0 投票する
2 に答える
336 参照

visual-studio-2008 - MS Visual Studio 2008 は、自分の関数に Javadoc スタイルのコメントを使用すると、ヘルプを表示しますか?

たとえば、C# または JavaScript ドキュメントで。
そうでない場合、ASP.NET プログラミングでJavadocコメントを使用する意味はありますか?

0 投票する
5 に答える
13551 参照

javadoc - Javadoc を NetBeans のライブラリに添付

NetBeans IDE を初めて使用します。たとえば、Java API (Systemクラスなど) のドキュメントを見ようとすると、javadoc がインストールされていないと表示されます。ドキュメントのインストール方法を教えてください。

0 投票する
8 に答える
11543 参照

delphi - javadoc または c# xml doc に似た Delphi のコード ドキュメント

Delphi コード用の javadoc または c# xml doc に似たコード ドキュメント ツールが必要です。最適なツールは何ですか? 私は、Microsoft のサンドキャッスル プロジェクトと将来的に互換性のあるテクノロジを好みます。

0 投票する
4 に答える
948 参照

java - javadoc-comments で何かが抜けている場合、javadoc から警告を取得することは可能ですか?

メソッドやクラスなどを文書化するときに、いくつかのパラメーターや例外スロー (またはその他のもの) を誤って説明するのを忘れる場合があります。

欠落しているドキュメント項目について警告するように javadoc を実行することは可能ですか?

(ドキュメントの生成には ant スクリプトを使用します)

0 投票する
1 に答える
1164 参照

java - javadoc メソッドのグループ化

クラスのメソッドを javadoc にグループ化したいと考えています。例えば:

javadocでこれを達成する方法を知っていますか? これを行うために利用できるドックレットはありますか?

ありがとう、カルム