Java ドキュメント コメントを使用してドキュメントを生成するにはどうすればよいですか?

Java では、単一行コメント、複数行コメント、ドキュメント コメントという 3 種類のコメントがサポートされていることはわかっています。どのようなものかを見てみましょう

//単一行コメント

/*
複数行コメント
*/

/**
*@...
*....
*ドキュメントのコメント
*/

おそらく多くの初心者はそうではありませんこのコメントを書くことに何の意味があるのか​​理解してください 毛織物？

実際のところ、初心者はコードの量が少なく、コメントなしですぐに見つけて変更できるためです。

コードが徐々に増えてくると、コメントは自分のためだけでなく、良いことになります。明確にするために コードを明確に見ることは、一緒にプロジェクトを開発するメンバーの便宜にもなります

コメントを書かないという悪い習慣を取り除くことを忘れないでください。 ！ ！

それでは、ここからが今日のテーマです。Doc コメントとは何ですか?

Javadoc は Sun が提供する技術で、プログラムのソース コードからクラス、メソッド、メンバーなどのコメントを抽出して、ソース コードに一致する API ヘルプ ドキュメントを作成します。つまり、プログラムを作成するときに特定のタグのセットをコメントとして使用する限り、プログラムを作成した後、Javadoc を通じてプログラムの開発ドキュメントを同時に作成できます。

javadoc コマンドは、API ドキュメントの生成に使用されます。使用方法: コマンド ラインを使用して、ターゲット ファイルが配置されているディレクトリに javadoc ファイル名 .java と入力します。複雑な理論に巻き込まれる必要はなく、ある種の思考を養う必要があります。理解する、理解する、深く掘り下げる、変更する、理解する、理論に固執しても効果はありません。

コードを書くときは、標準が存在します。書いたコードが実行できるが、それが混乱している場合は、メンテナンスが難しいため、誰もそのコードを使用しようとはしません。したがって、コードは単なる標準ではありません。オンラインの世界、私はそれを芸術作品と呼びたいのですが、慎重な彫刻が必要です

これはただの注釈ではないかと言う人もいるかもしれません。これの何が問題ですか。

ただし、この Doc コメントは他の 2 つのコメントとは異なります。コメントにも基準があります。

ドキュメント コメントの仕様

形式:

クラスに書かれたドキュメント コメントは、通常 3 つの段落に分かれています:

最初の段落: 概要説明。通常、このタイプの機能を 1 つの文または段落で簡潔に説明し、英語のピリオドで終わります。

2 番目の段落: 詳細な説明。通常は 1 つ以上の段落を使用して、このタイプの機能を詳細に説明します (通常は各段落)。英語のピリオドで終わります

3 番目の段落: ドキュメントの注釈。作成者、作成時刻、参照クラス、その他の情報をマークするために使用されます

ここで、少し知識を深めたいと思います。ドキュメント コメントには Dos コマンドを使用するか、IDE ツールでドキュメント ドキュメントを生成します。このドキュメントは HTML 言語で記述されているため、次のような簡単な HTML コードをコメントに追加できます。

改行

セグメンテーション

(段落の前に記述)

スタイル図の例を載せます:

@symbol# の使用

## Doc コメントを書くとき、/** の直後に Enter キーを押すと、次のコメント フレームといくつかの @ 記号が自動的に生成されます。

#タグ説明例##@author@deprecated{@docRoot}@Exception{@inheritDoc}挿入別のトピックへのリンク 別のトピックへのインライン リンクを挿入します。#@paramメソッドのパラメータを記述します。通常はメソッドのコメントに使用されます。#@return戻り値の型を説明します。通常はメソッドのコメントに使用され、構築メソッドには現れません #@see@serial@serialData#@serialFieldObjectStreamField コンポーネントの説明@serialField 名の型の説明@sinceこの機能がどのバージョンから含まれているかを示します@リリース以降@throws タグは同じです@Exception タグとしての意味。定数の値を表示します。定数は静的フィールドである必要があります。@バージョン情報@次の部分は英語ですが、@author XiaojianDoc コメントを書いた後、Doc ドキュメントを生成できると上で述べましたが、それは HTML 形式ですが、どのように生成すればよいでしょうか? javadoc [オプション] [パッケージ名] [ソースファイル]形式の説明:

クラスを識別します。 author、通常はクラスの注釈に使用されます	@author description
は、期限切れのクラスまたはメンバーを指定し、クラスまたはメソッドを示します。	@非推奨の説明の使用は推奨されません
現在のドキュメント ルート ディレクトリのパスを示します	ディレクトリ パス
スローされる可能性のある例外の説明。通常はメソッドのコメントに使用されます。	@例外例外名の説明
直接の上位クラスからコメントを継承します。		{@ link}
{@リンク名テキスト}		{@linkplain}
		##@param パラメータ名の説明
	##@return description
別のトピックへのリンクを指定します	@アンカーを参照
シリアル化属性を説明します	@シリアルの説明
writeObject() および writeExternal() メソッドを通じて書き込まれるデータを説明します	@serialData の説明
		##@throws
	{@value}	定数の値を表示します。静的属性である必要があります。
	@version	クラスのバージョンを指定します。通常は次の目的で使用されます。クラス アノテーション
		## のように中国語で記述できます。 #Doc ドキュメントを生成する方法
最初: Dos コマンドの生成

options

は Javadoc コマンドのオプションを表します;

packagenames

はパッケージ名を表します;

sourcefiles

はソース ファイル名を表します;

cmd (コマンド プロンプト) で

javadoc -help

と入力すると、Javadoc の使用法とオプションが表示されます (JDK がインストールされ、構成されている場合)。Javadoc コマンドの一般的なオプションを以下に示します。 :

NameDescription

-public

パブリック クラスとメンバーのみを表示します

-protected保護/パブリック クラスとメンバーを表示 (デフォルト)-packageパッケージ/保護/パブリック クラスとメンバーを表示すべてのクラスとメンバーを表示##-d 出力ファイルの宛先ディレクトリ-version@version セクションが含まれます - author@author セグメントが含まれます-splitindex文字ごとにインデックスを 1 つのファイルに分割しますDoc で生成するのは面倒で時間がかかります。他の方法は?毛織物? 2 番目: IDE ツールの生成Eclipse または IDEA を使用して生成できます。私は Eclipse をあまり使用しません。IDEA を使用してデモを行います。 ツール内の JavaDoc に入力すると、次のようになります。 出力ディレクトリを選択する必要があります。そうでない場合は生成されます。いいえ、、注意してください。Java のコーディングは IDEA のコーディングとは異なるため、その他のコマンド パラメーターの列には、次の内容を記入する必要があります

	##-private
##-windowtitle	ドキュメントのブラウザ ウィンドウ タイトル

-encoding utf8 -docencoding utf8 -charset utf8

生成後は次のようになります

以上がJava ドキュメント コメントを使用してドキュメントを生成するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。