1 '\" t |
1 ." Copyright 2002-2006 Sun Microsystems, Inc. All Rights Reserved. |
2 .\" Copyright 2006 Sun Microsystems, Inc. All Rights Reserved. |
2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 ." |
4 .\" |
4 ." This code is free software; you can redistribute it and/or modify it |
5 .\" This code is free software; you can redistribute it and/or modify it |
5 ." under the terms of the GNU General Public License version 2 only, as |
6 .\" under the terms of the GNU General Public License version 2 only, as |
6 ." published by the Free Software Foundation. |
7 .\" published by the Free Software Foundation. |
7 ." |
8 .\" |
8 ." This code is distributed in the hope that it will be useful, but WITHOUT |
9 .\" This code is distributed in the hope that it will be useful, but WITHOUT |
9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
10 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
11 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
11 ." version 2 for more details (a copy is included in the LICENSE file that |
12 .\" version 2 for more details (a copy is included in the LICENSE file that |
12 ." accompanied this code). |
13 .\" accompanied this code). |
13 ." |
14 .\" |
14 ." You should have received a copy of the GNU General Public License version |
15 .\" You should have received a copy of the GNU General Public License version |
15 ." 2 along with this work; if not, write to the Free Software Foundation, |
16 .\" 2 along with this work; if not, write to the Free Software Foundation, |
16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
17 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
17 ." |
18 .\" |
18 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
19 .\" Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
19 ." CA 95054 USA or visit www.sun.com if you need additional information or |
20 .\" CA 95054 USA or visit www.sun.com if you need additional information or |
20 ." have any questions. |
21 .\" have any questions. |
21 ." |
22 .\" ` |
22 .TH javadoc 1 "04 May 2009" |
23 .TH javadoc 1 "2006 年 9 月 4 日" "Java SE 6" "ユーザーコマンド" |
23 ." Generated from HTML by html2man (author: Eric Armstrong) |
24 .hw javadoc |
24 .SH "" |
25 .SH "名前" |
25 javadoc \- Java API ャ<潟吾с若 |
26 javadoc \- Java API ドキュメントジェネレータ |
26 .RS 3 |
27 .RS 3 |
27 |
28 |
28 .LP |
29 .LP |
29 .LP |
30 .LP |
30 Java 純若鴻<ゃAPI ャ<潟 HTML 若吾障ャ<潟х換篁 Javadoc 箴Sun Solaris 篏睡翫с |
31 Java ソースファイルから、API ドキュメントの HTML ページを生成します。このドキュメントで紹介されている Javadoc の例は、Sun Solaris を使用した場合のものです。 |
31 .LP |
32 .LP |
32 .RE |
33 .SH "形式" |
33 .SH "綵√" |
34 .B javadoc |
34 .LP |
35 [ |
35 .LP |
36 .I options |
36 \f4javadoc\fP\f2\ [\ \fP\f2options\fP\f2\ ]\ [\ packagenames\ ]\ [\ sourcefilenames\ ]\ [\ \-subpackages\fP\ \f2pkg1:pkg2:...\fP\f2\ ]\ [\ \fP\f2@argfiles\fP\f2\ ]\fP |
37 ] [ |
37 .LP |
38 .I packagenames |
38 .LP |
39 ] [ |
39 綣違絎綺篁紙сJavadoc 若с絲乗院 \f2.java\fP <ゃ羆阪号荅括完ゃ純若鴻<ゃс |
40 .I sourcefilenames |
40 .LP |
41 ] [ |
41 .RS 3 |
42 .I \-subpackages pkg1:pkg2:... |
42 |
43 ] [ |
43 .LP |
44 .I @argfiles |
44 .RS 3 |
45 ] |
45 .TP 3 |
46 .LP |
46 options |
47 .LP |
47 ャ<潟ц潟潟茵激с潟сJavadoc 激с潟罔羣篏睡羈ゃ篏睡箴с |
48 引数を指定する順序は任意です。Javadoc ツールでの、処理対象の \f2.java\fP ファイルを決定する方法の詳細については、「ソースファイルの処理」を参照してください。 |
48 .TP 3 |
49 .TP 15 |
49 packagenames |
50 .I options |
50 鴻若鴻у阪筝c宴若後с 違\f2java.lang\ java.lang.reflect\ java.awt\fP 絎障ャ<潟宴若吾ャ絎綽荀障ゃ若篏睡筝с 絽亥\-subpackages 篏睡障Javadoc 若\f2\-sourcepath\fP 篏帥c宴若後罎膣≪障1 や札筝宴若吾ャ<潟箴с |
51 このドキュメントで指定されているコマンド行オプションです。 |
51 .TP 3 |
52 .B javadoc |
52 sourcefilenames |
53 のオプションの一般的な使用法については、「使用例」を参照してください。 |
53 鴻若鴻у阪筝c純若鴻<ゃс<ゃ鴻у障障≪鴻帥鴻 (*) ゃ若с障 Javadoc 若<ゃ.java≦宍絖х≦宍絖ゃ絎鴻劫с鴻<ゃс ( |
54 .TP |
|
55 .I packagenames |
|
56 .BR "java.lang java.lang.reflect java.awt" |
|
57 などの、スペースで区切られた |
|
58 一連のパッケージ名です。ドキュメント化するパッケージごとに別個に |
|
59 指定する必要があります。 |
|
60 .B javadoc |
|
61 ツールはこれらのパッケージ名を探すとき、 |
|
62 .B \-sourcepath |
|
63 を使用します。 |
|
64 .B javadoc |
|
65 ツールは、サブパッケージを再帰的に処理することはありません。 |
|
66 アスタリスク (\f3*\f1) などのワイルドカードは使うことができません。 |
|
67 「1 つ以上のパッケージのドキュメント化」の |
|
68 例を参照してください。 |
|
69 .TP |
|
70 .I sourcefilenames |
|
71 スペースで区切られた一連のファイル名です。パス、および |
|
72 アスタリスク (\f3*\f1) などのワイルドカードを含めることができます。 |
|
73 .B javadoc |
|
74 ツールが処理するのは、ファイル名が「.java」という拡張子で終わり、 |
|
75 その拡張子を除いた名前が実際に有効なクラス名 |
|
76 .fi |
|
77 (http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625 |
|
78 の |
|
79 .na |
54 .na |
80 「\f2Identifiers\fP」を参照) であるすべてのファイルです。 |
55 \f2Identifiers\fP @ |
81 したがって、ハイフンを含む名前 (X-Buffer など) や、 |
56 .fi |
82 その他の無効な文字を含む名前を付けることによって、 |
57 http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625)cゃ潟 (\f2X\-Buffer\fP ) 篁≦鴻絖篁c<ゃャ<潟絲乗院ゅс障鴻<ゃ潟若<ゃ翫箴水с 純若鴻<ゃ絎鴻cjavadoc <ゃ罎膣≪贋羆冴障障Javadoc 若純若鴻<ゃ罎膣≪ \f2\-sourcepath\fP 篏帥障後障鴻憜c後障鴻с \f2Button.java\fP 羝<\f2./Button.java\fP 羝<с純若鴻<ゃ鴻ф絎\f2/home/src/java/awt/Graphics*.java\fP 障1 や札筝鴻ャ<潟箴с障宴若吾鴻ャ<潟箴宴若後純若鴻<ゃ羞桁с障 |
83 それらのファイルをドキュメント化の対象から除外できます。 |
58 .TP 3 |
84 これは、テスト用のファイルや、テンプレートから生成されたファイルの場合に便利です。 |
59 \-subpackages pkg1:pkg2:... |
85 .B javadoc |
60 純若鴻<ゃ絎宴若吾潟泣宴若後絽亥ャ<潟障宴若後障純若鴻<ゃ絎綽荀障 |
86 ツールは、ソースファイル名の前に指定されたパスを使用して、 |
61 .TP 3 |
87 ソースファイル名を探します。この場合、 |
62 @argfiles |
88 .B -sourcepath |
63 Javadoc 激с潟宴若後潟純若鴻<ゃ篁紙綺т研鴻鴻障 1 や札筝<ゃс<ゃ筝сゃ若 (*) \f2\-J\fP 激с潟絎с障 |
89 は使用しません。たとえば、 |
64 .RE |
90 .B Button.java |
65 |
91 を渡すことは |
66 .LP |
92 .BR ./Button.java |
67 .RE |
93 と指定することと同じです。完全パスを付けたソースファイル名の |
68 .SH " 茯" |
94 例は「 |
69 .LP |
95 .BR /home/src/java/awt/Graphics*.java |
70 .LP |
96 」のようになります。「1 つ以上のクラスのドキュメント化」の例を |
71 \f3Javadoc\fP 若筝c Java 純若鴻<ゃ絎h潟ャ<潟若激с潟潟<潟茹fс public 鴻protected 鴻ャ絖 (水鴻ゃ)ゃ潟帥с若鴻潟潟鴻帥<純潟c若ゃ茯筝c HTML 若吾障障API (≪宴若激с潟違潟違ゃ潟帥с若) ャ<潟筝c純若鴻<ゃ絎茖ャ<潟篏睡с障 |
97 参照してください。また、「パッケージとクラスのドキュメント化」の |
72 .LP |
98 例のように、パッケージ名とソースファイル名を組み合わせることもできます。 |
73 .LP |
99 .TP |
74 Javadoc 若宴若後篏純若鴻<ゃ障筝≧鴻絲障絎茵с障javadoc 若宴若後篏絲障絎茵翫筝篏c絽亥 \f2\-subpackages\fP 篏睡宴若後腓榊鴻羝<障純若鴻<ゃ絲障 javadoc 絎茵翫筝c純若 (\f2.java\fP) <ゃ羝<障隙箴ャ<潟緇膣剛障罨<Javadoc 純若鴻<ゃゃ茯障 |
100 .I \-subpackages pkg1:pkg2:... |
|
101 指定されたパッケージ内のソースファイルからドキュメントを生成し、 |
|
102 再帰的にサブパッケージを処理します。 パッケージ名または |
|
103 ソールファイル名を指定するための代替手段です。 |
|
104 .TP |
|
105 .I @argfiles |
|
106 Javadoc オプション、パッケージ名、およびソースファイル名を |
|
107 任意の順序で並べたリストが含まれる 1 つ以上のファイルです。 |
|
108 このファイルの中では、ワイルドカード (*) および |
|
109 .B \-J |
|
110 オプションは指定できません。 |
|
111 .SH "機能説明" |
|
112 .B javadoc |
|
113 ツールは、一連の Java ソースファイルの宣言およびドキュメント |
|
114 コメントを解析し、デフォルトでは public クラスと protected クラス、 |
|
115 入れ子クラス(匿名の内部クラスを除く)、インタフェース、コンストラクタ、メソッド、および |
|
116 フィールドについて説明した一連の HTML ページを生成します。また、API (アプリケーションプログラミングインタフェース) ドキュメントの生成や、一連のソースファイルの実装ドキュメントの生成に使用できます。 |
|
117 .LP |
|
118 .B javadoc |
|
119 ツールは、パッケージ全体、個々のソースファイル、またはその両方に対して |
|
120 実行できます。 |
|
121 .B javadoc |
|
122 ツールをパッケージ全体に対して実行する場合は、最上位ディレクトリから再帰的にたどるために -subpackages を使用するか、パッケージ名の明示的なリストを渡します。 |
|
123 個々のクラスに対して javadoc を実行する場合は、一連の |
|
124 ソース (\f3.java\f1) ファイル名を渡します。具体的な例は、 |
|
125 このページの最後で示します。 |
|
126 次に、Javadoc によるソースファイルの処理について説明します。 |
|
127 .LP |
75 .LP |
128 .SS |
76 .SS |
129 ソースファイルの処理 |
77 純若鴻<ゃ |
130 .LP |
78 .LP |
131 .LP |
79 .LP |
132 Javadoc ツールは、末尾に \f2.java\fP の付いたファイル以外に、ソースファイルで説明する他のファイルも処理します。個々のソースファイル名を明示的に渡すことによって Javadoc ツールを実行する場合、\f2.java\fP ファイルを処理するかを正確に指定できます。ただし、多くの開発者はこの方法では作業しません。パッケージ名を渡すほうが簡単だからです。ソースファイル名を明示的に指定しなくても、Javadoc ツールは 3 つの方法で実行できます。この方法は、(1) パッケージ名を渡す、(2) \f2\-subpackages\fP を使用する、(3) ソースファイル名にワイルドカードを使用する (\f2*.java\fP) という方法です。これらの方法を使用する場合、Javadoc ツールは、\f2*.java\fP ファイルが次のすべての要件を満たしている場合にかぎり、このファイルを処理します。 |
80 Javadoc 若絨障 \f2.java\fP 篁<ゃ篁ュ純若鴻<ゃц篁<ゃ障純若鴻<ゃ腓榊羝<c Javadoc 若絎茵翫 \f2.java\fP <ゃ罩g∈絎с障紊肴号с篏罐障 宴若後羝<祉膂≦с純若鴻<ゃ腓榊絎Javadoc 若 3 ゃ号у茵с障号(1) 宴若後羝<(2) \f2\-subpackages\fP 篏睡(3) 純若鴻<ゃゃ若篏睡 (\f2*.java\fP) 号с号篏睡翫Javadoc 若\f2.java\fP <ゃ罨<鴻荀篁吟羣翫<ゃ障 |
133 .LP |
81 .LP |
134 .RS 3 |
82 .RS 3 |
135 .TP 2 |
83 .TP 2 |
136 o |
84 o |
137 名前から \f2.java\fP の接尾辞を取り除くと、実際に有効なクラス名になっている (有効な文字については、 |
85 \f2.java\fP ・絨乗ゃ絎鴻劫c (鴻絖ゃ |
138 .fi |
|
139 http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625 |
|
140 の |
|
141 .na |
86 .na |
142 「\f2Identifiers\fP」を参照) |
87 \f2Identifiers\fP @ |
143 .TP 2 |
88 .fi |
144 o |
89 http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625) |
145 ソースツリーのルートから相対的なディレクトリパスが、区切り文字をドットに変換すると、実際に有効なパッケージ名になっている |
90 .TP 2 |
146 .TP 2 |
91 o |
147 o |
92 純若鴻若若後丞c鴻阪絖紊絎鴻宴若後c |
148 パッケージ文には有効なパッケージ名が含まれる (前項目で指定) |
93 .TP 2 |
149 .RE |
94 o |
150 |
95 宴若御鴻宴若後障 (ф絎) |
151 .LP |
96 .RE |
152 .LP |
97 |
153 \f3リンクの処理\fP \- |
98 .LP |
154 実行時に、 |
99 .LP |
155 .B javadoc |
100 \f3潟\fP \- Javadoc 若絎茵筝絎茵сャ<潟宴若吾鴻潟<潟若絲障娯с潟菴遵障潟罨<贋菴遵障 |
156 ツールはその実行の一部として記述されているパッケージ、クラス、 |
101 .LP |
157 およびメンバの名称にクロスリファレンスリンクを自動的に |
102 .RS 3 |
158 追加します。リンクは、次の箇所に現われます。 |
103 .TP 2 |
159 .LP |
104 o |
160 .TP 2 |
105 絎h (祉ゃ綣違c若) |
161 \(bu |
106 .TP 2 |
162 宣言 (戻り値の型、引数の型、フィールドの型) |
107 o |
163 .TP 2 |
108 \f2@see\fP 帥違 [∫i] 祉激с |
164 \(bu |
109 .TP 2 |
165 @see タグから生成される [関連項目] のセクション |
110 o |
166 .TP 2 |
111 \f2{@link}\fP 帥違ゃ潟ゃ潟鴻 |
167 \(bu |
112 .TP 2 |
168 {@link} タグから生成されるインラインテキスト |
113 o |
169 .TP 2 |
114 \f2@throws\fP 帥違箴紊 |
170 \(bu |
115 .TP 2 |
171 @throws タグから生成される例外の名称 |
116 o |
172 .TP 2 |
117 "ゃ潟帥с若鴻<潟若絲障 [絎臂] 潟鴻<潟若絲障 [若若ゃ] 潟 |
173 \(bu |
118 .TP 2 |
174 インタフェースのメンバに対する [定義] リンクと、クラスのメンバに対する [オーバーライド] リンク |
119 o |
175 .TP 2 |
120 宴若吾鴻潟<潟若网荀若 |
176 \(bu |
121 .TP 2 |
177 パッケージ、クラス、およびメンバを記述した一覧表 |
122 o |
178 .TP 2 |
123 宴若吾潟鴻膓帥 |
179 \(bu |
124 .TP 2 |
180 パッケージとクラスの継承ツリー |
125 o |
181 .TP 2 |
126 膣√ |
182 \(bu |
127 .RE |
183 索引 |
128 |
184 .LP |
129 .LP |
185 \-link と \-linkoffline オプションを使用して、 |
130 .LP |
186 コマンド行に含まれていない、個別に生成されるクラスの既存のテキストに |
131 潟潟茵ф絎c鴻ゃ√鴻 (ャ鴻) 絲障ゃ若潟菴遵\f2\-link\fP \f2\-linkoffline\fP 激с潟с障 |
187 ハイパーリンクを追加できます。 |
132 .LP |
188 .LP |
133 .LP |
189 \f3その他の処理についての詳細\fP \- |
134 \f3篁ゃ荅括完\fP \- Javadoc 若絎茵潟 1 ゃ絎ャ<潟篏障 ャ<潟菴遵с障 ゃ障Javadoc 若篁ュ絎茵腟篆罩c絎鴻贋・腟水ャс障菴違篁ュ絎茵腟絲障潟菴遵с障 |
190 javadoc ツールは、実行のたびにひとつの完全なドキュメントを生成します。javadoc は、 |
135 .LP |
191 追加生成を行えません。つまり、以前に実行した javadoc の結果を変更したり、 |
136 .LP |
192 それらを直接取り込むことはできません。しかし、前述のようにほかの |
137 絎茖筝宴Javadoc 若絎茵 java 潟潟ゃ綽荀java 潟潟ゃ箴絖障Javadoc 若 \f2javac\fP 筝若喝冴絎h潟潟ゃ<潟若絎茖∴障Javadoc 若拷絮ゃ鴻莟絲茵憗鴻篏睡≫罕膀宴 HTML 障Javadoc 若純若鴻潟若ャ<潟若激с潟潟<潟若吟若箴ャ<潟緇障 |
193 実行の結果にリンクすることは可能です。 |
138 .LP |
194 .LP |
139 .LP |
195 実装上の理由から、 |
140 Javadoc 若<純篏膣膕鴻帥<ゃс \f2.java\fP 純若鴻<ゃ絲障絎茵с障cAPI 篏絎茖荐菴違荐荐罧級сャ<潟若激с潟潟<潟荐菴違 javadoc 若絎茵с障 |
196 .B javadoc |
141 .LP |
197 ツールは実行に java コンパイラを必要とし、java コンパイラに依存しています。 |
142 .LP |
198 .B javadoc |
143 潟潟ゃ箴絖cHTML 阪絎絎茖罩g∈絲上障 絎絎茖腓榊純若鴻潟若с藥純若鴻潟若箴絖翫障違Javadoc 若\f2.class\fP <ゃ絖純若鴻潟若絖 |
199 ツールは |
144 .na |
200 .B javac |
145 \f2潟潟鴻\fP @ |
201 の一部を呼び出して、宣言をコンパイルし、メンバの実装は無視します。 |
146 .fi |
202 .B javadoc |
147 http://java.sun.com/docs/books/jls/second_edition/html/names.doc.html#36154 (Java 荐茯篁罕祉激с 8.6.7) ャ<潟障 |
203 ツールは、クラス階層を含むクラスの豊富な内部表現、および「使用」関係を |
148 .LP |
204 構築し、そこから HTML を生成します。 |
149 .LP |
205 .B javadoc |
150 絽吾Javadoc 若с純若鴻<ゃ潟若筝絎障若с翫сャ<潟с障違激ャ若c潟違絎篋ャ<潟с障違Java 荐茯篁罕処院<純鴻篏処院絎h違障若罎冴javac 潟潟ゃ罩≪障Javadoc 若茘冴膓茵障Javadoc 若ャ<潟若激с潟潟<潟堺с茵障ャ<潟若激с潟潟<潟荅潟с綽荀翫DocCheck 篏睡 |
206 ツールは、ソースコードのドキュメンテーションコメントから、ユーザの |
151 .LP |
207 提供するドキュメントも取得します。 |
152 .LP |
208 .LP |
153 Javadoc 若ャ<潟罕罕膀с鴻鴻若障Javadoc 若若鴻鴻≦宍罘純障若吟若鴻鴻с鴻罎膣≪с違障荅括完 |
209 .B javadoc |
154 .na |
210 ツールは、メソッド本体のない純粋なスタブファイルである |
155 \f2鴻罎膣∽号\fP @ |
211 .B .java |
156 .fi |
212 ソースファイル上で実行されます。つまり、API の作成時には、コードを |
157 http://java.sun.com/javase/6/docs/technotes/tools/findingclasses.htmlс絽吾篏鴻≦宍罘純若Javadoc 若鴻劫臀鏆荀障 |
213 記述する前の設計の早い段階でドキュメンテーションコメントを記述し、 |
158 .LP |
214 .B javadoc |
159 .SS |
215 を実行できます。 |
160 Javadoc |
216 .LP |
161 .LP |
217 コンパイラに依存することによって、HTML 出力が、実際の実装に正確に対応 |
162 .LP |
218 することが保証されます。実際の実装は、明示的でなく暗黙的に |
163 Javadoc 若阪絎鴻綵√篏帥c鴻帥ゃ冴с障Javadoc 若罔羣若違腟粋昭帥障 罔羣HTML 綵√ API ャ<潟障罔羣篆罩c障泣劫HTMLXMLMIFRTF 絅純帥阪綵√荐菴違純с篏睡羈ゃ罨<с |
219 ソースコードに依存している場合があります。たとえば、 |
164 .LP |
220 .B javadoc |
165 .RS 3 |
221 ツールは、 |
166 .TP 2 |
222 .B .class |
167 o |
223 ファイル内には存在するが、ソースコード内には存在しない |
168 .na |
224 デフォルトコンストラクタ (「Java Language Specification」のセクション 8.6.7: http://java.sun.com/docs/books/jls/second_edition/html/names.doc.html#36154) |
169 \f2Javadoc \fP @ |
225 をドキュメント化します。 |
170 .fi |
226 .LP |
171 http://java.sun.com/javase/6/docs/technotes/guides/javadoc/index.html |
227 多くの場合、 |
172 .TP 2 |
228 .B javadoc |
173 o |
229 ツールでは、ソースファイルのコードが不完全またはエラーを |
174 \f2\-doclet\fP 潟潟茵激с |
230 含んでいる場合でもドキュメントを生成できます。 |
175 .RE |
231 このため、デバッグやトラブルシューティングが完了する前に |
176 |
232 ドキュメントを生成できます。 たとえば、Java 言語仕様によると、 |
177 .LP |
233 抽象メソッドを含むクラスはそれ自体を抽象と宣言しなければなりません。 |
178 .LP |
234 このエラーを検出すると、javac コンパイラの場合は、このエラーで |
179 \f2\-doclet\fP 潟潟茵激с潟с鴻帥絎翫Javadoc 若罔羣篏睡障javadoc 若篏睡≫鋎睡с潟潟茵激с潟障罔羣с祉ゃ潟潟茵激с潟菴遵障<激с潟ゃ激с潟ц障 |
235 停止しますが、javadoc ツールは警告を出さずに処理を進めます。 |
180 .LP |
236 javadoc ツールはドキュメンテーションコメントの基本的なチェックを行います。 |
181 .SS |
237 ドキュメンテーションコメントをより詳しくチェックする必要がある場合は、 |
182 ∫cャ<潟潟 |
238 DocCheck ドックレットを使用してください。 |
183 .LP |
239 .LP |
184 .RS 3 |
240 .B javadoc |
185 .TP 2 |
241 ツールがドキュメント用の内部構造を構築するときは、参照する |
186 o |
242 クラスをすべてロードします。このため、ブートストラップクラス、 |
187 .na |
243 拡張機能、またはユーザクラスにかかわらず、 |
188 \f2Javadoc 純罘遵七\fP @ |
244 .B javadoc |
189 .fi |
245 ツールは、参照するクラスをすべて検出できなければなりません。 |
190 http://java.sun.com/javase/6/docs/technotes/guides/javadoc/index.html \- Javadoc ц申壕鴻荅括完 |
246 一般的に、作成する |
191 .TP 2 |
247 クラスは、拡張機能としてロードされるか、 |
192 o |
248 .BR javadoc |
193 .na |
249 ツールのクラスパス内にある必要があります。 |
194 \f2Javadoc FAQ\fP @ |
250 .SS "Javadoc ドックレット" |
195 .fi |
251 .B javadoc |
196 http://java.sun.com/j2se/javadoc/faq/index.html \- 紫絲莖絲障膈Javadoc ∫c若ゃ宴潟違炊号 |
252 ツールの出力の内容と形式は、ドックレットを使ってカスタマイズできます。 |
197 .TP 2 |
253 .B javadoc |
198 o |
254 ツールには、標準ドックレットと呼ばれるデフォルトの「組み込み型」 |
199 .na |
255 ドックレットがあり、これによって HTML 形式の API |
200 \f2How to Write Doc Comments for Javadoc\fP @ |
256 ドキュメントを生成します。標準ドックレット |
201 .fi |
257 の修正やサブクラス化を行なったり、HTML、XML、MIF、RTF などの好みの |
202 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html \- ャ<潟若激с潟潟<潟荐菴井号≪ Sun 荀靘 |
258 出力形式を生成する独自のドックレットを記述することも可能です。 |
203 .TP 2 |
259 ドックレットとその使用法については、次を参照してください。 |
204 o |
260 .LP |
205 .na |
261 .TP 2 |
206 \f2Requirements for Writing API Specifications\fP @ |
262 \(bu |
207 .fi |
263 .B Javadoc |
208 http://java.sun.com/j2se/javadoc/writingapispecs/index.html \- Java 2 若篁罕荐菴違篏睡罔羣荀篁吟宴純若鴻<ゃャ<潟若激с潟潟<潟綵√ API 篁罕荐菴違翫篁綵√ц菴違翫綵合<障罎荐弱純≪泣若激с潟羣宴若吾鴻ゃ潟帥с若鴻c若潟<純ゃ荀篁吟絎障 |
264 ドックレット |
209 .TP 2 |
265 .TP 2 |
210 o |
266 \(bu |
211 .na |
267 .B -doclet |
212 \f2ャ<潟若激с潟潟<潟篁罕\fP @ |
268 コマンド行オプション |
213 .fi |
269 .LP |
214 http://java.sun.com/docs/books/jls/first_edition/html/18.doc.html \- ャ<潟若激с潟潟<潟吾篁罕ゃJava Language Specification (James GoslingBill JoyGuy Steele 沿) 膃 18 腴Documentation Commentsс腴膃 2 сゃ障 |
270 .B -doclet |
215 .TP 2 |
271 コマンド行オプションでカスタムドックレットが指定されていない場合、 |
216 o |
272 .B javadoc |
217 .na |
273 ツールは、デフォルトの標準ドックレットを使用します。 |
218 \f2DocCheck \fP @ |
274 .B javadoc |
219 .fi |
275 ツールには、どのドックレットが使われているかには関係なく使用できる |
220 http://java.sun.com/javadoc/doccheck \- 純若鴻<ゃャ<潟若激с潟潟<潟с罎冴若筝罩c若障Sun Doc Check 若cc若筝сSun Doc Check 若cc若筝с |
276 コマンド行オプションがあります。標準ドックレットでは、これらの |
221 .TP 2 |
277 ほかに、いくつかのコマンド行オプションが追加されます。どちらの |
222 o |
278 オプションについても、後述の「オプション」で説明します。 |
223 .na |
279 .SS 関連ドキュメントおよびドックレット |
224 \f2MIF \fP @ |
280 .TP 2 |
225 .fi |
281 \(bu |
226 http://java.sun.com/javadoc/mifdoclet \- MIFFrameMakerPDF 後 API ャ<潟障MIF Adobe FrameMaker 篋ゆ後с |
282 Javadoc に施された機能強化 - Javadoc に追加された改良点の詳細 |
227 .RE |
283 .TP 2 |
228 |
284 \(bu |
229 .LP |
285 Javadoc FAQ - 頻繁に寄せられる質問に対する回答、Javadoc 関連のツールについての情報、およびバグの回避方法 |
230 .SS |
286 .TP 2 |
231 茯 |
287 \(bu |
232 .LP |
288 Javadoc のドキュメンテーションを作成するには - Sun で |
233 .LP |
289 一般的なドキュメンテーションコメントの記述方法の詳細 |
234 \f2ャ<潟若激с潟潟<潟\fP\f2doc 潟<潟\fP\f2筝肢\fP\f2帥違\fP\f2帥違\fP\f2ゃ潟ゃ潟帥違\fP茯ゃャ<潟若激с潟潟<潟ц障罨<篁茯Javadoc 若潟潟鴻х劫潟<障 |
290 .TP 2 |
235 .LP |
291 \(bu |
236 .RS 3 |
292 API 仕様を記述するための要件 - Java 2 プラットフォーム仕様を記述する際に |
237 .TP 3 |
293 使用された標準要件。 この情報は、ソースファイルのドキュメンテーションコメント |
238 ャ<潟 (generated document) |
294 形式で API 仕様を記述する場合にも、その他の形式で記述する場合にも |
239 javadoc 若 Java 純若鴻潟若ャ<潟若激с潟潟<潟ャ<潟сャ<潟 HTML 綵√с罔羣c篏障 |
295 役立ちます。 検証可能なアサーションを満たすパッケージ、クラス、 |
240 .LP |
296 インタフェース、フィールド、およびメソッドについての要件を定めています。 |
241 .TP 3 |
297 .TP 2 |
242 (name) |
298 \(bu |
243 Java 荐茯ф吾違荀膣ゃ障宴若吾鴻ゃ潟帥с若鴻c若潟潟鴻帥障<純с\f2java.lang.String.equals(java.lang.Object)\fP 絎篆蕋障\f2equals(Object)\fP 篆蕋障с障 |
299 ドキュメンテーションコメントの仕様 - ドキュメンテーションコメントの |
244 .LP |
300 オリジナル仕様については、『Java Language Specification』 |
245 .TP 3 |
301 (James Gosling、Bill Joy、Guy Steele 共著) の初版の |
246 ャ<潟 (documented classes) |
302 第 18 章「Documentation Comments」を参照してください。 |
247 javadoc 若絎茵c荅括完ャ<潟鴻潟ゃ潟帥с若鴻сャ<潟純若鴻<ゃ篏睡純с違純若鴻<ゃ障宴若後 javadoc 潟潟羝<≪祉剛信蕋上 (publicprotectedpackage\-private 障 private) cc水違障ャ<潟鴻javadoc 若阪腟粋昭障鴻ゃ障鴻若違障 |
303 この章は、第 2 版では削除されました。 |
248 .LP |
304 .TP 2 |
249 .TP 3 |
305 \(bu |
250 (included classes) |
306 DocCheck ドックレット - ソースファイル内のドキュメンテーションコメントを検査し、 |
251 若絎茵c荅括完ャ<潟鴻潟ゃ潟帥с若鴻сャ<潟鴻 |
307 見つかったエラーや不規則な箇所を一覧にしたレポートを生成します。 |
252 .LP |
308 これは Sun Doc チェックユーティリティの一部です。 |
253 .TP 3 |
309 .TP 2 |
254 ゅ (excluded classes) |
310 \(bu |
255 若絎茵c荅括完ャ<潟鴻潟ゃ潟帥с若鴻с |
311 MIF ドックレット - MIF、FrameMaker、および PDF 形式での API ドキュメントの |
256 .LP |
312 生成を自動化します。 MIF は Adobe FrameMaker の互換形式です。 |
257 .TP 3 |
313 .SS "用語" |
258 с (referenced classes) |
314 .LP |
259 ャ<潟鴻潟ゃ潟帥с若鴻絎臂 (絎茖) 障ャ<潟若激с潟潟<潟筝ф腓榊с鴻潟ゃ潟帥с若鴻сс箴祉ゃ<若帥c鴻≦宍鴻絎茖ゃ潟帥с若鴻ゃ潟若鴻<純篏т戎鴻@see{@link}{@linkplain}{@inheritDoc} 帥違障絎臂 |
315 .LP |
260 .na |
316 「\f2ドキュメンテーションコメント\fP」、「\f2doc コメント\fP」、「\f2主説明\fP」、「\f2タグ\fP」、「\f2ブロックタグ\fP」、および「\f2インラインタグ\fP」の用語については、「ドキュメンテーションコメント」で説明します。以下のその他の用語は、Javadoc ツールのコンテキストで特定の意味を持ちます。 |
261 \f21.3\fP @ |
317 .RS 3 |
262 .fi |
318 .TP 3 |
263 http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html#referencedclasses 紊眼障javadoc 若絎茵Javadoc 若鴻鴻潟鴻劫鴻с鴻<≪若若綽荀障с鴻荀ゃ翫鴻荀ゃ障茘茵腓冴障Javadoc 若鴻絖<潟若絎絎ゅャ綽荀鴻宴.class <ゃ綣冴с障 |
319 生成されるドキュメント |
264 .LP |
320 .B javadoc |
265 .TP 3 |
321 ツールが Java ソースコード内の doc コメントから生成したドキュメント |
266 紊с (external referenced classes) |
322 のことです。デフォルトの生成ドキュメントは HTML 形式で、標準 |
267 с鴻<javadoc 若絎茵筝ャ<潟鴻сゃ障鴻潟潟茵 Javadoc 若羝<障ャ<潟с鴻潟膊紊с障紊潟若違障違\f2java.awt\fP 宴若吾絲障 Javadoc 若絎茵翫\f2Object\fP \f2java.lang\fP 鴻鴻紊с鴻障紊с鴻潟\f2\-link\fP \f2\-linkoffline\fP 激с潟篏睡障紊с鴻絽吾純若鴻潟<潟 javadoc 若絎茵ус荀劫彰障翫潟<潟膓帥с障 |
323 ドックレットによって作成されます。 |
268 .RE |
324 .LP |
269 |
325 .TP 3 |
270 .LP |
326 名前 |
271 .SH "純若鴻<ゃ" |
327 Java 言語での名前、つまりパッケージ、クラス、インタフェース、 |
272 .LP |
328 フィールド、コンストラクタ、またはメソッドの名前のことです。名前は、 |
273 .LP |
329 .BR java.lang.String.equals(java.lang.Object) |
274 Javadoc 若4 腮蕁違純若鴻<ゃ阪腟障<ゃ鴻 Java 荐茯純若鴻<ゃ (\f2.java\fP)宴若吾潟<潟<ゃ网荀潟<潟<ゃ潟篁<ゃс障ャ<潟純若鴻若絖翫鴻<ゃ潟若<ゃゃ茯障 |
330 のように完全修飾することも、 |
275 .LP |
331 .BR equals(Object) |
276 .SS |
332 のように部分修飾することもできます。 |
277 鴻純若鴻潟若<ゃ |
333 .LP |
278 .LP |
334 .TP 3 |
279 .LP |
335 ドキュメント化されるクラス |
280 鴻障ゃ潟帥с若鴻潟<潟若ャ<潟若激с潟潟<潟ゃс \f2.java\fP <ゃ篆障ャ<潟若激с潟潟<潟荅括完ャ<潟若激с潟潟<潟с |
336 .B javadoc |
281 .LP |
337 の実行によって完全なドキュメントが生成されるクラスと |
282 .SS |
338 インタフェースです。ドキュメント化するには、ソースファイルが |
283 宴若吾潟<潟<ゃ |
339 使用可能でなければならず、ソースファイル名またはパッケージ名の |
284 .LP |
340 どちらかを |
285 .LP |
341 .B javadoc |
286 宴若吾ャ<潟若激с潟潟<潟ゃс絨純若鴻<ゃ篆障 絎鴻Javadoc 若c网荀若吾腟粋昭障障潟<潟絽吾宴若後篏綵障ャ<潟荐菴違障 |
342 コマンドに渡さなければなりません。ドキュメント化されるクラスは、 |
287 .LP |
343 .B javadoc |
288 .LP |
344 の実行で組み込まれるクラス、つまり「組み込みクラス」とも呼ばれます。 |
289 宴若吾潟<潟<ゃ篏翫潟<潟主罨< 2 ゃ<ゃ御с障 |
345 .LP |
290 .LP |
346 .TP 3 |
291 .RS 3 |
347 含まれるクラス |
292 .TP 2 |
348 対応するソースファイル名またはパッケージ名が javadoc コマンドに |
293 o |
349 渡されるクラスおよびインタフェースのことです。 |
294 \f2package\-info.java\fP \- 宴若後h宴若御絵宴若吾潟<潟 Javadoc 帥違主с障<ゃ JDK 5.0 уャсpackage.html ィ絅障 |
350 .LP |
295 .TP 2 |
351 .TP 3 |
296 o |
352 除外されるクラス |
297 \f2package.html\fP \- 主с宴若吾潟<潟 Javadoc 帥違с 宴若御絵主с障 |
353 javadoc コマンドにソースファイル名またはパッケージ名が |
298 .RE |
354 渡されないクラスとインタフェースです。 |
299 |
355 .LP |
300 .LP |
356 .TP 3 |
301 .LP |
357 参照クラス |
302 宴若吾筝 \f2package.html\fP <ゃ筝 \f2package\-info.java\fP <ゃゃс障筝≧鴻ゃс障<<ゃ \f2.java\fP <ゃ純若鴻弱宴若吾c臀 |
358 ドキュメント化されるクラスとインタフェースの定義 |
303 .LP |
359 (実装) またはドキュメンテーションコメント内で明示的に参照される |
304 .LP |
360 クラスとインタフェースです。参照の例としては、 |
305 \f4package\-info.java\fP \- <ゃ罨<罕宴若吾潟<潟主с障 潟<潟宴若後h臀障 |
361 戻り値の型、パラメータの型、キャストの型、 |
306 .LP |
362 拡張されるクラス、実装されるインタフェース、 |
307 .LP |
363 インポートされるクラス、メソッド本体で使用される |
308 File:\f2java/applet/package\-info.java\fP |
364 クラス、@see、{@link}、{@linkplain}、 |
309 .LP |
365 および {@inheritDoc} タグなどがあります |
310 .LP |
366 (この定義は 1.3 |
311 .TS |
367 .fi |
312 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
368 (http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html#referencedclasses) |
313 .de 35 |
369 から |
314 .ps \n(.s |
370 変更されていることに注意)。 |
315 .vs \n(.vu |
371 javadoc ツールは動作中、 |
316 .in \n(.iu |
372 .B javadoc |
317 .if \n(.u .fi |
373 のブートクラスパスと |
318 .if \n(.j .ad |
374 クラスパス内にある参照されているクラスを |
319 .if \n(.j=0 .na |
375 すべてメモリにロードするためです。 |
320 .. |
376 参照されているクラスが見つからなかった |
321 .nf |
377 場合は、[クラスが見つかりません] という警告が表示されます。 |
322 .nr #~ 0 |
378 .B javadoc |
323 .if n .nr #~ 0.6n |
379 ツールは、クラスの存在とそのメンバの完全修飾名を決定するのに十分な情報を、 |
324 .ds #d .d |
380 .B .class |
325 .if \(ts\n(.z\(ts\(ts .ds #d nl |
381 ファイルから引き出すことができます。 |
326 .fc |
382 .LP |
327 .nr 33 \n(.s |
383 .TP 3 |
328 .rm 80 |
384 外部参照クラス |
329 .nr 34 \n(.lu |
385 参照されるクラスのうち、 |
330 .eo |
386 .B javadoc |
331 .am 80 |
387 を実行してもドキュメントが生成されないクラスです。 |
332 .br |
388 つまり、これらのクラスは、コマンド行で |
333 .di a+ |
389 .B javadoc |
334 .35 |
390 ツールに渡されていません。 |
335 .ft \n(.f |
391 生成ドキュメント内でこれらのクラスにリンクしている箇所は、 |
336 .ll \n(34u*1u/2u |
392 「外部参照」または「外部リンク」と呼ばれます。 たとえば、 |
337 .if \n(.l<\n(80 .ll \n(80u |
393 .B java.awt |
338 .in 0 |
394 パッケージに対してだけ |
339 .nf |
395 .B javadoc |
340 \f3 |
396 を実行した場合、Object などの |
341 .fl |
397 .BR java.lang |
|
398 内のすべてのクラスは、外部参照クラスになります。外部参照クラスには、 |
|
399 .B \-link |
|
400 および |
|
401 .B \-linkoffline |
|
402 オプションを使ってリンクすることができます。 |
|
403 外部参照クラスには、通常そのソースコメントを |
|
404 .B \javadoc |
|
405 ツールの実行で利用できないという重要な特徴があります。 |
|
406 この場合、それらのコメントを継承することはできません。 |
|
407 .SH "ソースファイル" |
|
408 .B javadoc |
|
409 ツールは、クラスの Java 言語ソースファイル (\f3.java\f1)、パッケージコメントファイル、 |
|
410 概要コメントファイル、およびその他の処理されないファイルの 4 種類の |
|
411 「ソース」ファイルを基にして、出力を生成します。また、ドキュメント化しないがソースツリーに存在する場合があるテストファイルやテンプレートについても説明します。 |
|
412 .SS "クラスソースコードファイル" |
|
413 各クラスまたはインタフェース、およびそのメンバは、 |
|
414 .B .java |
|
415 ファイルの中にそれ自身のドキュメンテーションコメントを |
|
416 持つことができます。ドキュメンテーションコメントの詳細については、 |
|
417 「ドキュメンテーションコメント」の節を参照してください。 |
|
418 .SS "パッケージコメントファイル" |
|
419 各パッケージは、独自のドキュメンテーションコメントを |
|
420 持つことができ、「ソース」ファイルに保持します。 |
|
421 .B javadoc |
|
422 ツールは、生成するパッケージの要約ページにこのコメントをマージします。 |
|
423 通常、このコメントには、パッケージ全体に適用される |
|
424 ドキュメントを含めます。 |
|
425 .LP |
|
426 パッケージコメントファイルを作成する場合、コメントの格納先として、次の 2 つのファイルのいずれかを選択できます。 |
|
427 .LP |
|
428 .RS 3 |
|
429 .TP 2 |
|
430 o |
|
431 \f2package\-info.java\fP \- パッケージ宣言、パッケージ注釈、パッケージコメント、および Javadoc タグを格納できます。このファイルは JDK 5.0 で導入されたものであり、package.html よりも推奨されています。 |
|
432 .TP 2 |
|
433 o |
|
434 \f2package.html\fP \- 格納できるのはパッケージコメントと Javadoc タグだけです。パッケージ注釈は格納できません。 |
|
435 .RE |
|
436 |
|
437 .LP |
|
438 .LP |
|
439 各パッケージは、単一の \f2package.html\fP ファイル、単一の \f2package\-info.java\fP ファイルのいずれかを持つことができますが、両方を持つことはできません。このどちらかのファイルを \f2.java\fP ファイルとともに、ソースツリー内のそのパッケージのディレクトリ内に配置してください。 |
|
440 .LP |
|
441 .LP |
|
442 \f4package\-info.java\fP このファイルには、次の構造のパッケージコメントを格納できます。コメントはパッケージ宣言の前に配置します。 |
|
443 .LP |
|
444 .LP |
|
445 File: \f2java/applet/package\-info.java\fP |
|
446 .LP |
|
447 .ft 3 |
|
448 .nf |
|
449 /** |
342 /** |
450 * Provides the classes necessary to create an |
343 .fl |
|
344 * Provides the classes necessary to create an |
|
345 .fl |
451 * applet and the classes an applet uses |
346 * applet and the classes an applet uses |
|
347 .fl |
452 * to communicate with its applet context. |
348 * to communicate with its applet context. |
|
349 .fl |
453 * <p> |
350 * <p> |
|
351 .fl |
454 * The applet framework involves two entities: |
352 * The applet framework involves two entities: |
|
353 .fl |
455 * the applet and the applet context. |
354 * the applet and the applet context. |
|
355 .fl |
456 * An applet is an embeddable window (see the |
356 * An applet is an embeddable window (see the |
|
357 .fl |
457 * {@link java.awt.Panel} class) with a few extra |
358 * {@link java.awt.Panel} class) with a few extra |
|
359 .fl |
458 * methods that the applet context can use to |
360 * methods that the applet context can use to |
|
361 .fl |
459 * initialize, start, and stop the applet. |
362 * initialize, start, and stop the applet. |
|
363 .fl |
460 * |
364 * |
|
365 .fl |
461 * @since 1.0 |
366 * @since 1.0 |
|
367 .fl |
462 * @see java.awt |
368 * @see java.awt |
|
369 .fl |
463 */ |
370 */ |
|
371 .fl |
464 package java.lang.applet; |
372 package java.lang.applet; |
465 .fi |
373 .fl |
466 .ft 1 |
374 \fP |
467 .LP |
375 .fi |
468 コメント区切り文字の \f2/**\fP と \f2*/\fP は記述する必要がありますが、中間行の行頭のアスタリスクは省略してもかまいません。 |
376 .br |
469 .LP |
377 .di |
470 .LP |
378 .nr a| \n(dn |
471 \f4package.html\fP \- このファイルには、次の構造のパッケージコメントを格納できます。コメントは \f2<body>\fP 要素内に配置します。 |
379 .nr a- \n(dl |
472 .LP |
380 .. |
473 .LP |
381 .ec \ |
474 File: \f2java/applet/package.html\fP |
382 .35 |
475 .LP |
383 .nf |
476 .LP |
384 .ll \n(34u |
477 .ft 3 |
385 .nr 80 0 |
478 .nf |
386 .80 |
479 <HTML> |
387 .rm 80 |
480 <BODY> |
388 .nr 38 \n(a- |
481 Provides the classes necessary to create an applet and the |
389 .if \n(80<\n(38 .nr 80 \n(38 |
482 classes an applet uses to communicate with its applet context. |
390 .35 |
483 <p> |
391 .nf |
484 The applet framework involves two entities: the applet |
392 .ll \n(34u |
485 and the applet context. An applet is an embeddable |
393 .nr 38 1n |
486 window (see the {@link java.awt.Panel} class) with a |
394 .nr 79 0 |
487 few extra methods that the applet context can use to |
395 .nr 40 \n(79+(0*\n(38) |
488 initialize, start, and stop the applet. |
396 .nr 80 +\n(40 |
489 |
397 .nr TW \n(80 |
490 @since 1.0 |
398 .if t .if \n(TW>\n(.li .tm Table at line 353 file Input is too wide - \n(TW units |
491 @see java.awt |
399 .fc |
492 </BODY> |
400 .nr #T 0-1 |
493 </HTML> |
401 .nr #a 0-1 |
494 .fi |
402 .eo |
495 .ft 1 |
403 .de T# |
496 .LP |
404 .ds #d .d |
497 .LP |
405 .if \(ts\n(.z\(ts\(ts .ds #d nl |
498 これは単なる通常の HTML ファイルであり、パッケージ宣言を含んでいない点に注意してください。パッケージコメントファイルの内容は、ほかのすべてのコメントと同様に HTML で記述されています。ただし、ほかのコメントと異なる点が 1 つだけあります。それは、このドキュメンテーションコメントには、コメント区切り文字である \f2/**\fP と \f2*/\fP、および行頭のアスタリスクを含めてはならない、ということです。コメントを書く場合は、最初の文をパッケージの概要とし、\f2<body>\fP と最初の文の間にタイトルやその他のテキストを含めないようにします。パッケージタグを含めることはできますが、ほかのドキュメンテーションコメントと同様、全てのブロックタグは説明のあとに置かなければなりません。パッケージコメントファイルに \f2@see\fP タグを追加する場合は、完全指定の名前を使用する必要があります。詳細は、 |
406 .mk ## |
499 .fi |
407 .nr ## -1v |
500 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#packagecomments |
408 .ls 1 |
501 の |
409 .ls |
502 .na |
410 .. |
503 「\f2example of \fP\f2package.html\fP」を参照してください。 |
411 .ec |
504 .LP |
412 .ne \n(a|u+\n(.Vu |
505 .LP |
413 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
506 \f3パッケージコメントファイルの処理\fP \- Javadoc ツールは、実行時にパッケージコメントファイルを自動的に検索し、このファイルを見つけると次の処理を行います。 |
414 .ta \n(80u |
507 .LP |
415 .nr 31 \n(.f |
508 .RS 3 |
416 .nr 35 1m |
509 .TP 2 |
417 \&\h'|\n(40u' |
510 o |
418 .mk ## |
511 処理できるようにコメントをコピーする (\f2package.html\fP の場合であれば、\f2<body>\fP と \f2</body>\fP HTML タグの間にある内容をすべてコピーする。\f2<head>\fP を含め、そこに \f2<title>\fP やソースファイルの著作権記述などの情報を配置することもできるが、生成後のドキュメンテーションにはそれらは一切表示されない) |
419 .nr 31 \n(## |
512 .TP 2 |
420 .sp |\n(##u-1v |
513 o |
421 .nr 37 \n(40u |
514 パッケージタグがあれば、すべて処理する |
422 .in +\n(37u |
515 .TP 2 |
423 .a+ |
516 o |
424 .in -\n(37u |
517 生成したパッケージの概要ページの最後に、処理したテキストを挿入する (例: パッケージの概要) |
425 .mk 32 |
518 .TP 2 |
426 .if \n(32>\n(31 .nr 31 \n(32 |
519 o |
427 .sp |\n(31u |
520 パッケージの概要ページの先頭に、パッケージコメントの最初の文をコピーする。さらに、概要ページのパッケージリストに、パッケージ名とパッケージコメントの最初の文を追加する (例: 概要の要約)。文の末尾は、クラスやメンバの主説明の最初の文の末尾と同じ規則によって判断される |
428 .fc |
521 .RE |
429 .nr T. 1 |
522 |
430 .T# 1 |
523 .LP |
431 .35 |
524 .SS "概要コメントファイル" |
432 .rm a+ |
525 ドキュメント化する各アプリケーションまたはパッケージのセットは、 |
|
526 独自の概要ドキュメンテーションコメントを持つことができ、それは |
|
527 「ソース」ファイルに保持されます。 |
|
528 .B javadoc |
|
529 ツールは、生成する概要ページにこのコメントをマージします。通常、この |
|
530 コメントには、アプリケーションまたはパッケージのセット全体に |
|
531 当てはまるドキュメントを含めます。 |
|
532 .LP |
|
533 概要コメントファイルを作成する場合、ファイルに好きな名前を付けて、 |
|
534 好きな場所に置くことができますが、通常はファイル名を |
|
535 .B overview.html |
|
536 にして、ソースツリーの一番上の階層に置きます。 |
|
537 たとえば、 |
|
538 .B java.applet |
|
539 パッケージのソースファイルが |
|
540 .B /home/user/src/java/applet |
|
541 ディレクトリに含まれているとすると、 |
|
542 .BR /home/user/src/overview.html |
|
543 に概要コメントファイルを作成することができます。 |
|
544 .LP |
|
545 異なるパッケージのセットに対して javadoc を複数回実行する場合は、同じ 1 つのソースファイルのセットに対して複数の概要コメントファイルを作成できます。 |
|
546 たとえば、内部ドキュメンテーション用に \-private を指定して javadoc を 1 回実行したあと、公開ドキュメンテーション用にそのオプションを指定しないで再度実行することができます。この場合、各概要コメントファイルの 1 文目で、そのドキュメンテーションを公開用または内部用として記述できます。 |
|
547 .LP |
|
548 概要コメントファイルの内容は、前に述べたパッケージコメントファイルと |
|
549 同様、HTML で記述された 1 つの大きなドキュメント |
|
550 コメントです。詳細は、前述の説明を参照してください。繰り返しに |
|
551 なりますが、このコメントを書く場合は、最初の文をアプリケーション |
|
552 またはパッケージのセットの要約にし、 |
|
553 .B <body> |
|
554 と最初の文の間にタイトルまたはその他のテキストを含めてはなりません。 |
|
555 概要タグを含めることができます。どのドキュメンテーションコメントに |
|
556 ついても、{\f3@link\f1} |
|
557 以外のタグは、説明のあとに置く必要があります。 |
|
558 .B @see |
|
559 タグを追加する場合は、完全指定の名前を使用する必要があります。 |
|
560 .LP |
|
561 .BR javadoc |
|
562 ツールの実行時に、 |
|
563 .B \-overview |
|
564 オプションを使って概要コメントファイル名を指定します。ファイルは、 |
|
565 パッケージコメントファイルと同じように処理されます。 |
|
566 .TP 2 |
|
567 \(bu |
|
568 .B <body> |
|
569 タグと |
|
570 .B </body> |
|
571 タグとの間にあるすべての内容を処理のためにコピーする |
|
572 .TP 2 |
|
573 \(bu |
|
574 存在する概要タグを処理する |
|
575 .TP 2 |
|
576 \(bu |
|
577 概要の要約などの Javadoc が生成する概要ページの最後に、 |
|
578 処理されたテキストを挿入する |
|
579 .TP 2 |
|
580 \(bu |
|
581 概要ページの先頭に、概要コメントの最初の文をコピーする |
|
582 .SS "その他の処理されないファイル" |
|
583 ソースには、 |
|
584 .B javadoc |
|
585 ツールで生成先のディレクトリにコピーする、その他の任意のファイルを |
|
586 含めることができます。一般に、このようなファイルには、 |
|
587 サンプルのグラフィックファイル、Java ソース |
|
588 (\f3.java\f1) およびクラス (\f3.class\f1) ファイル、内容が |
|
589 通常の Java ソース |
|
590 ファイルのドキュメンテーションコメントの影響を受けない |
|
591 独立した HTML ファイルなどがあります。 |
|
592 .LP |
|
593 処理されないファイルを含めるには、それらのファイルを |
|
594 .BR doc-files |
|
595 というディレクトリに置きます。このディレクトリは、任意のパッケージ |
|
596 ディレクトリの下に作成できます。パッケージごとにこのようなサブ |
|
597 ディレクトリを 1 つ持つことができます。このサブディレクトリには、 |
|
598 イメージ、サンプルコード、ソースファイル、 |
|
599 .B .class |
|
600 ファイル、アプレット、および HTML ファイルを入れることができます。 |
|
601 たとえば、ボタンの画像 |
|
602 .B button.gif |
|
603 を |
|
604 .B java.awt.Button |
|
605 クラスドキュメントに含めたい場合は、そのファイルを |
|
606 .B /home/user/src/java/awt/doc-files/ |
|
607 ディレクトリに置きます。 |
|
608 .BR doc-files |
|
609 ディレクトリを |
|
610 .B /home/user/src/java/doc-files |
|
611 に置くことはできません。これは、 |
|
612 .B java |
|
613 はパッケージではなく、そのディレクトリそのものにソースファイルが |
|
614 入っていないからです。 |
|
615 .LP |
|
616 これらの処理されないファイルへのリンクは |
|
617 すべて明示的に記述する必要があります。これは、 |
|
618 .B javadoc |
|
619 ツールがファイルを見ずに、単にディレクトリとその内容物を生成先に |
|
620 コピーするだけだからです。たとえば、 |
|
621 .B Button.java |
|
622 ドキュメンテーションコメント内のリンクは、次のようになります。 |
|
623 .LP |
|
624 .ft 3 |
|
625 .nf |
|
626 /** |
|
627 * This button looks like this: |
|
628 * <img src="doc-files/Button.gif"> |
|
629 */ |
|
630 .fi |
|
631 .ft 1 |
|
632 .SH "テストファイルおよびテンプレートファイル" |
|
633 一部の開発者から、テストファイルおよびテンプレートファイルを |
|
634 対応するソースファイルの近くのソースツリーに保存したいという要望がありました。 |
|
635 つまり、これらのソースファイルと同じディレクトリまたはサブディレクトリに |
|
636 保存したいということです。 |
|
637 .LP |
|
638 個別のソースファイル名で明示的に渡して |
|
639 .B Javadoc |
|
640 ツールを実行する場合は、 |
|
641 テストファイルおよびテンプレートファイルを意図的に除外して、 |
|
642 処理されないようにすることができます。ただし、パッケージ名または |
|
643 ワイルドカードで渡す場合は、以下のルールに従って、これらのテストファイル |
|
644 およびテンプレートファイルが |
|
645 処理されないようにする必要があります。 |
|
646 .LP |
|
647 テストファイルとテンプレートファイルの違いは、 |
|
648 テストファイルは、正当でコンパイル可能なソースファイルであるのに対して、 |
|
649 テンプレートファイルは、そうではないという点です。ただし、 |
|
650 テンプレートファイルも「.java」で終わることができます。 |
|
651 .TP |
|
652 テストファイル \- |
|
653 開発者の多くは、あるパッケージのコンパイル可能で実行可能な |
|
654 テストファイルをそのパッケージのソースファイルと同じ |
|
655 ディレクトリに配置したいと考えています。 |
|
656 しかしテストファイルは、名前なしパッケージなど、 |
|
657 ソースファイルパッケージとは別のパッケージに属させたいとも |
|
658 考えています (そのため、テストファイルには package ステートメントがないか、 |
|
659 またはソースとは別の package ステートメントがあります)。 |
|
660 このような状況では、コマンド行で指定されているソースのパッケージ名を指定して |
|
661 そのソースがドキュメント化されているときに、 |
|
662 テストファイルは警告またはエラーを引き起こします。 |
|
663 そのようなテストファイルはサブディレクトリに配置する必要があります。 |
|
664 たとえばソースファイルのテストファイルを |
|
665 .B com.package1 |
|
666 に追加する場合は、それらのテストファイルを、ハイフンが含まれるため |
|
667 パッケージ名としては無効になる |
|
668 サブディレクトリに配置します。 |
|
669 .LP |
|
670 .RS 5 |
|
671 com/package1/test-files/ |
|
672 .RE |
|
673 .LP |
|
674 こうすると、 |
|
675 .B Javadoc |
|
676 ツールでは警告なしで |
|
677 test ディレクトリをスキップします。 |
|
678 .LP |
|
679 テストファイルに doc コメントが含まれる場合、 |
|
680 次のようにワイルドカードを含んだテストソースファイル名で渡して |
|
681 テストファイルのドキュメントを生成するように、 |
|
682 .B Javadoc |
|
683 ツールを別個に実行できるように設定できます。 |
|
684 \f2com/package1/test\-files/*.java\fP. |
|
685 .TP |
|
686 ソースファイルのテンプレート\- |
|
687 テンプレートファイルの名前は「.java」で終わることもありますが、 |
|
688 テンプレートファイルはコンパイルできません。 |
|
689 ソースディレクトリに保持したいソースファイルの |
|
690 テンプレートがある場合は、 |
|
691 このファイル名にハイフン (Buffer-Template.java など) や |
|
692 その他の不正な Java 文字を使用します。 |
|
693 こうすることで、処理されないようになります。 |
|
694 これは、 |
|
695 .B Javadoc |
|
696 ツールが処理するのは、「.java」接尾辞を除いた名前が |
|
697 正規のクラス名であるソースファイルだけであるためです (「識別子」http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625 参照)。 |
|
698 .SS "生成されるファイル" |
|
699 デフォルトでは、 |
|
700 .B javadoc |
|
701 は、HTML 形式のドキュメントを生成する標準ドックレットを |
|
702 使います。 |
|
703 このドックレットは、以下の種類のファイルを生成します。以下の |
|
704 各 HTML「ページ」は、それぞれ別のファイルに対応します。 |
|
705 .B javadoc |
|
706 が生成するファイルの名前には、クラスやインタフェースの名前に |
|
707 ちなんだものと、そうでないもの (\f3package-summary.html\f1 など) |
|
708 の 2 種類があります。後者のグループには、前者のグループの名前と |
|
709 ファイル名が競合しないように、ハイフンが含まれています。 |
|
710 .SS "基本内容ページ" |
|
711 .TP 2 |
|
712 \(bu |
|
713 ドキュメント化する各クラスまたは各インタフェースに対し、1 つのクラス |
|
714 ページまたはインタフェースページ (\f3classname.html\f1) |
|
715 .TP 2 |
|
716 \(bu |
|
717 ドキュメント化する各パッケージに対し、1 つのパッケージ |
|
718 ページ (\f3package-summary.html\f1)。 |
|
719 .B javadoc |
|
720 ツールによって、ソースツリーのパッケージディレクトリ内の |
|
721 .B package.html |
|
722 または |
|
723 package\-info.java |
|
724 というファイル内のすべての HTML テキストが含められる |
|
725 .TP 2 |
|
726 \(bu |
|
727 パッケージのセット全体に対して 1 つの概要 |
|
728 ページ (\f3overview-summary.html\f1)。これは、生成される |
|
729 ドキュメントの先頭ページになる。 |
|
730 .B javadoc |
|
731 ツールによって、 |
|
732 .B -overview |
|
733 オプションで指定されたファイル内のすべての HTML テキストが含められる。 |
|
734 このファイルが作成されるのは、 |
|
735 .B javadoc |
|
736 に 2 つ以上のパッケージ名を渡した |
|
737 場合だけであることに注意する。詳細は、以下の「HTML フレーム」節を参照 |
|
738 .SS "相互参照ページ" |
|
739 .TP 2 |
|
740 \(bu |
|
741 パッケージのセット全体に対して 1 つのクラス階層ページ |
|
742 (\f3overview-tree.html\f1)。これを表示するには、ナビゲーション |
|
743 バーの [概要] をクリックしてから、[階層ツリー] をクリックする |
|
744 .TP 2 |
|
745 \(bu |
|
746 各パッケージに対して 1 つのクラス階層 |
|
747 ページ (\f3package-tree.html\f1)。 |
|
748 特定のパッケージページ、クラスページ、またはインタフェースページを |
|
749 表示し、[階層ツリー] をクリックすると、そのパッケージの階層が |
|
750 表示される |
|
751 .TP 2 |
|
752 \(bu |
|
753 各パッケージに対して 1 つの [使用] |
|
754 ページ (\f3package-use.html\f1)と、 |
|
755 各クラスおよびインタフェースに対して別に 1 つの [使用] |
|
756 ページ(\f3class-use/classname.html\f1)。このページは、特定のクラス、 |
|
757 インタフェース、またはパッケージのなんらかの部分を使っている |
|
758 パッケージ、クラス、メソッド、コンストラクタ、およびフィールドを |
|
759 記述する。クラスまたはインタフェース A について考えると、 |
|
760 その[使用] ページには、A のサブクラス、A として宣言された |
|
761 フィールド、A を返すメソッド、A 型のパラメータを持つメソッド |
|
762 およびコンストラクタが表示される。このページには、パッケージ、 |
|
763 クラス、またはインタフェースに移動してから、ナビゲーションバー |
|
764 の [使用] リンクをクリックすることによってアクセスできる |
|
765 .TP 2 |
|
766 \(bu |
|
767 非推奨 API ページ (\f3deprecated-list.html\f1)。推奨されない |
|
768 名前すべての一覧が含まれている (非推奨名は、通常は改良された API が |
|
769 存在するために使用が推奨されていない API の名前で、たいていはそれに |
|
770 置き換わる名前が提示されている。非推奨 API は、将来の実装では |
|
771 削除される可能性がある) |
|
772 .TP 2 |
|
773 \(bu |
|
774 定数フィールド値ページ (\f3constant-values.html\f1) 。 |
|
775 static フィールドの値が表示される。 |
|
776 .TP 2 |
|
777 \(bu |
|
778 直列化形式ページ (\f3serialized-form.html\f1)。直列化可能クラス |
|
779 および外部化可能クラスの情報用。これらの各クラスには、直列化 |
|
780 フィールドおよびメソッドに関する説明がある。これらの情報は、API を |
|
781 使う開発者ではなく、再実装者に必要な情報である。ナビゲーションバーに |
|
782 リンクがない場合、任意の直列化されたクラスに移動して、 |
|
783 クラスの [関連項目] セクション内の [直列化された形式] をクリック |
|
784 するとこの情報を取得できる |
|
785 標準ドックレットは、直列化された形式のページを自動的に生成する。 |
|
786 ここには、Serializable を実装する public または非 public の |
|
787 クラスが組み込まれており、さらに、 |
|
788 .B readObject |
|
789 メソッド、 |
|
790 .B writeObject |
|
791 メソッド、直列化されたフィールド、 |
|
792 および @serial タグ、@serialField タグ、@serialData タグからの |
|
793 ドキュメンテーションコメントが組み込まれている。 |
|
794 直列化が可能な public クラスを除外するには、 |
|
795 そのクラスまたはそのクラスが属するパッケージを @serial exclude タグで |
|
796 指定する。直列化が可能な package private クラスを含めるには、 |
|
797 そのクラスまたはそのクラスが属するパッケージを @serial include タグで |
|
798 指定する。 1.4 では、 |
|
799 \-private |
|
800 オプションを指定せずに javadoc を実行することで、public クラスおよび |
|
801 private クラスに完全な直列化形式を生成することができる。 |
|
802 .TP 2 |
|
803 \(bu |
|
804 索引 (\f3index-*.html\f1)。すべてのクラス名、 |
|
805 インタフェース名、コンストラクタ名、フィールド名、およびメソッド名を |
|
806 アルファベット順に並べてある。索引は、Unicode を扱えるように |
|
807 国際化されており、1 つのファイルとして生成するか、または先頭 |
|
808 文字 (英語の場合 A から Z) ごとに別のファイルとして生成できる |
|
809 .SS "サポートファイル" |
|
810 .TP 2 |
|
811 \(bu |
|
812 ヘルプページ (\f3help-doc.html\f1)。ナビゲーションバーおよび |
|
813 上記のページについて説明する。 |
|
814 .BR \-helpfile |
|
815 を使って、デフォルトの |
|
816 ヘルプファイルに置き換わる独自のカスタムヘルプファイルを提供する |
|
817 こともできる |
|
818 .TP 2 |
|
819 \(bu |
|
820 1 つの |
|
821 .B index.html |
|
822 ファイル。表示用 の HTML フレームを作成する。このファイルは、 |
|
823 フレーム付きの最初のページを表示する場合にロードする。このファイル |
|
824 自体は、テキスト内容を含まない |
|
825 .TP 2 |
|
826 \(bu |
|
827 複数のフレームファイル (\f3*-frame.html\f1)。パッケージ、クラス、 |
|
828 およびインタフェースの一覧を含む。HTML フレームを表示するときに |
|
829 使われる |
|
830 .TP 2 |
|
831 \(bu |
|
832 パッケージリストファイル (\f3package-list\f1)。 |
|
833 .B \-link |
|
834 オプションおよび |
|
835 .B \-linkoffline |
|
836 オプションで使われる。これは、HTML ファイルではなくテキストファイル |
|
837 のため、リンクではアクセスできない |
|
838 .TP 2 |
|
839 \(bu |
|
840 スタイルシートファイル (\f3stylesheet.css\f1)。生成されるページ上に |
|
841 表示される限られた色数、フォントファミリ、フォントサイズ、フォントの |
|
842 スタイルおよび配置を制御する |
|
843 .TP 2 |
|
844 \(bu |
|
845 コピー先ディレクトリにコピーしたいファイル (イメージ、サンプル、 |
|
846 ソースファイルなど) が入っている doc ファイルのディレクトリ。 |
|
847 .B javadoc |
|
848 ツールはこのようなファイルを処理しない。つまり、このようなファイル内の |
|
849 .B javadoc |
|
850 タグはすべて無視される。ソースツリーに存在しない限り、この |
|
851 ディレクトリは生成されない |
|
852 .SS "HTML フレーム" |
|
853 .B javadoc |
|
854 ツールは、下の図に示すように、2 つか 3 つの HTML フレームを生成します。 |
|
855 1 つのパッケージしかない場合 (またはパッケージがない場合) は、パッケージの一覧を省略することによって最低限必要な数のフレームを作成します。 |
|
856 ソースファイル (*\f3.java\f1) または単一のパッケージ名を引数として |
|
857 .B javadoc |
|
858 コマンドに渡す場合は、左側の列にクラスの一覧を表示する |
|
859 フレーム (C) 1 つだけが作成されます。 |
|
860 .B javadoc |
|
861 に複数のパッケージ名を渡す場合は、概要ページ (Detail) に加えて、 |
|
862 すべてのパッケージの一覧を表示する第 3 のフレーム (P) が |
|
863 作成されます。この概要ページのファイル名は |
|
864 .BR overview-summary.html |
|
865 です。したがって、このファイルが作成されるのは、2 つ以上のパッケージ |
|
866 名を渡した場合だけです。[フレームなし] リンクをクリックするか、 |
|
867 .BR overview-summary.html |
|
868 から表示するようにすると、フレームを省略できます。 |
|
869 .LP |
|
870 HTML フレームに慣れていない場合は、フレームには、印刷および |
|
871 スクロール用の「フォーカス」が必要であることに注意する |
|
872 必要があります。フレームにフォーカスを与えるには、そのフレームを |
|
873 クリックします。すると、多くのブラウザでは、矢印キーおよびページキー |
|
874 を使ってそのフレームをスクロールしたり、[印刷] メニュー |
|
875 コマンドを使ってそのフレームを印刷したりできるようになります。 |
|
876 .LP |
|
877 .ft 3 |
|
878 .nf |
|
879 ------------ ------------ |
|
880 |C| Detail | |P| Detail | |
|
881 | | | | | | |
|
882 | | | |-| | |
|
883 | | | |C| | |
|
884 | | | | | | |
|
885 | | | | | | |
|
886 ------------ ------------ |
|
887 javadoc *.java javadoc java.lang java.awt |
|
888 .fi |
|
889 .ft 1 |
|
890 .LP |
|
891 HTML フレームが必要かどうかによって、次のどちらかのファイルを |
|
892 開始ページとしてロードします。 |
|
893 .LP |
|
894 .TP 2 |
|
895 \(bu |
|
896 .B index.html |
|
897 (フレームあり) |
|
898 .TP 2 |
|
899 \(bu |
|
900 .B overview-summary.html |
|
901 (フレームなし) |
|
902 .SS "生成されるファイル構造" |
|
903 生成されるクラスファイルおよびインタフェースファイルは、Java ソース |
|
904 ファイルおよびクラスファイルと同じディレクトリ階層で組織 |
|
905 されます。この構造は、1 つのサブパッケージにつき 1 つのディレクトリ |
|
906 で構成されます。 |
|
907 .LP |
|
908 たとえば、 |
|
909 .B java.applet.Applet |
|
910 クラスに対して生成されるドキュメントは、 |
|
911 .BR java/applet/Applet.html |
|
912 に格納されます。生成先のディレクトリの名前が apidocs だと |
|
913 すると、java.applet パッケージのファイル構造もこれに従います。 |
|
914 前述したように、「frame」という語を名前に含むファイルは、 |
|
915 すべて左上または左下のフレームに表示されます。それ |
|
916 以外の HTML ファイルは、すべて右側のフレームに表示されます。 |
|
917 .LP |
|
918 注: ディレクトリは、太字 (bold) で示してあります。 |
|
919 アスタリスク (*) は、 |
|
920 .B javadoc |
|
921 への引数がパッケージ名でなくソースファイル名 (*\f3.java\f1) の |
|
922 ときに、省略されるファイルおよびディレクトリを示しています。また、 |
|
923 引数がソースファイル名のときには、 |
|
924 .B package-list |
|
925 は作成されますが、空です。 |
|
926 .B doc-files |
|
927 ディレクトリは、ソースツリー内に存在しない限り、生成先に表示されません。 |
|
928 .LP |
|
929 .RE |
|
930 .nf |
|
931 \f3 |
|
932 .fl |
|
933 |
|
934 .fl |
|
935 \fP\f3apidocs\fP 最上位ディレクトリ |
|
936 .fl |
|
937 index.html HTML フレームを設定する初期ページ |
|
938 .fl |
|
939 * overview\-summary.html 全パッケージのリスト。先頭に要約文がある |
|
940 .fl |
|
941 overview\-tree.html 全パッケージのクラス階層のリスト |
|
942 .fl |
|
943 deprecated\-list.html 全パッケージの推奨されない API のリスト |
|
944 .fl |
|
945 constant\-values.html 全パッケージの static フィールドの値のリスト |
|
946 .fl |
|
947 serialized\-form.html 全パッケージの直列化された形式のリスト |
|
948 .fl |
|
949 * overview\-frame.html 全パッケージのリスト。左上のフレームに表示される |
|
950 .fl |
|
951 allclasses\-frame.html 全パッケージの全クラスのリスト。左下のフレームに表示される |
|
952 .fl |
|
953 help\-doc.html これらのページの構成を示すユーザヘルプを表示する |
|
954 .fl |
|
955 index\-all.html \-splitindex オプションなしで作成されたデフォルト索引 |
|
956 .fl |
|
957 \f3index\-files\fP \-splitindex オプションを指定して作成されたディレクトリ |
|
958 .fl |
|
959 index\-<number>.html \-splitindex オプションを指定して作成された索引ファイル |
|
960 .fl |
|
961 package\-list パッケージ名のリスト。外部参照を解決するためだけに使用される |
|
962 .fl |
|
963 stylesheet.css フォント、色、配置を定義する HTML スタイルシート |
|
964 .fl |
|
965 \f3java\fP パッケージディレクトリ |
|
966 .fl |
|
967 \f3applet\fP サブパッケージディレクトリ |
|
968 .fl |
|
969 Applet.html Applet クラスのページ |
|
970 .fl |
|
971 AppletContext.html AppletContext インタフェースのページ |
|
972 .fl |
|
973 AppletStub.html AppletStub インタフェースのページ |
|
974 .fl |
|
975 AudioClip.html AudioClip インタフェースのページ |
|
976 .fl |
|
977 * package\-summary.html このパッケージのクラスのリスト。先頭に要約文がある |
|
978 .fl |
|
979 * package\-frame.html このパッケージのクラスのリスト。左下のフレームに表示される |
|
980 .fl |
|
981 * package\-tree.html このパッケージのクラス階層のリスト |
|
982 .fl |
|
983 package\-use このパッケージが使用されている場所のリスト |
|
984 .fl |
|
985 \f3doc\-files\fP イメージやサンプルのファイルが格納されるディレクトリ |
|
986 .fl |
|
987 \f3class\-use\fP API が使用されている場所のページを格納するディレクトリ |
|
988 .fl |
|
989 Applet.html Applet クラスを使用するページ |
|
990 .fl |
|
991 AppletContext.html AppletContext インタフェースを使用するページ |
|
992 .fl |
|
993 AppletStub.html AppletStub インタフェースを使用するページ |
|
994 .fl |
|
995 AudioClip.html AudioClip インタフェースを使用するページ |
|
996 .fl |
|
997 \f3src\-html\fP ソースコードディレクトリ |
|
998 .fl |
|
999 \f3java\fP パッケージディレクトリ |
|
1000 .fl |
|
1001 \f3applet\fP サブパッケージディレクトリ |
|
1002 .fl |
|
1003 Applet.html Applet ソースコードのページ |
|
1004 .fl |
|
1005 AppletContext.html AppletContext ソースコードのページ |
|
1006 .fl |
|
1007 AppletStub.html AppletStub ソースコードのページ |
|
1008 .fl |
|
1009 AudioClip.html AudioClip ソースコードのページ |
|
1010 .fl |
|
1011 .fi |
|
1012 |
|
1013 .LP |
|
1014 .SS "生成される API 宣言" |
|
1015 javadoc ツールは、各クラス、インタフェース、フィールド、コンストラクタ、 |
|
1016 およびメソッドの説明の初めで宣言を生成します。 |
|
1017 この宣言は、その API 項目の宣言です。たとえば、 |
|
1018 ブール型クラスの宣言は次のようになります。 |
|
1019 .LP |
|
1020 .LP |
|
1021 \f2public final class Boolean\fP |
|
1022 .br |
|
1023 \f2extends Object\fP |
|
1024 .br |
|
1025 \f2implements Serializable\fP |
|
1026 .LP |
|
1027 .LP |
|
1028 Boolean.valueOf メソッドの宣言は次のようになります。 |
|
1029 .LP |
|
1030 .LP |
|
1031 \f2public static Boolean valueOf(String s)\fP |
|
1032 .LP |
|
1033 .LP |
|
1034 javadoc ツールは修飾子 |
|
1035 .BR public |
|
1036 、 |
|
1037 .BR protected |
|
1038 、 |
|
1039 .BR private |
|
1040 、 |
|
1041 .BR abstract |
|
1042 、 |
|
1043 .BR final |
|
1044 、 |
|
1045 .BR static |
|
1046 、 |
|
1047 .BR transient |
|
1048 、 |
|
1049 および |
|
1050 .BR volatile |
|
1051 を組み込むことができますが、 |
|
1052 .BR synchronized |
|
1053 と |
|
1054 .BR native |
|
1055 は組み込むことができません。 |
|
1056 .BR synchronized |
|
1057 と |
|
1058 .BR native |
|
1059 修飾子は実装の詳細と見なされ、API 仕様の一部とは見なされません。 |
|
1060 .LP |
|
1061 キーワード |
|
1062 .BR synchronized |
|
1063 に依存するよりも、「複数のスレッドによって単一の |
|
1064 .BR Enumeration |
|
1065 を並行して使用してはならない」というように、並行処理のセマンティックスを |
|
1066 コメント説明の中でドキュメント化するべきです。ドキュメントでは、 |
|
1067 これらのセマンティックスの達成方法を説明すべきではありません。別の |
|
1068 例を挙げると、 |
|
1069 .BR Hashtable |
|
1070 はスレッドに対して安全でなければなりませんが、エクスポートされるその |
|
1071 メソッドすべてを同期させることによってこれを実現すると明記する必要 |
|
1072 はないということです。バケットレベルで内部的に同期をとる権限を留保して、 |
|
1073 より高度な並行性を提供すべきです。 |
|
1074 .LP |
|
1075 .SH "ドキュメンテーションコメント" |
|
1076 .LP |
|
1077 .LP |
|
1078 オリジナルの「ドキュメンテーションコメントの仕様」は、「関連項目」を参照してください。 |
|
1079 .LP |
|
1080 .SS |
|
1081 ソースコードへのコメントの挿入 |
|
1082 .LP |
|
1083 .LP |
|
1084 ソースコードの任意の宣言 (クラス、インタフェース、メソッド、コンストラクタ、 |
|
1085 またはフィールド) の前に、ドキュメンテーションコメント (doc コメント) |
|
1086 を記述することができます。 各パッケージにドキュメンテーションコメントを |
|
1087 作成でき、構文は若干異なりますが、概要にもドキュメンテーションコメントを |
|
1088 作成できます。 ドキュメンテーションコメントは、Javadoc コメントとも呼ばれます。 |
|
1089 ドキュメンテーションコメントは、コメントの始まりを示す文字列 |
|
1090 .B /** |
|
1091 と、コメントの終わりを示す文字列 |
|
1092 .B */ |
|
1093 の間にある文字で構成されます。 行頭のアスタリスクは、各行に記述できます。詳細は、以下で説明します。 Linux ではテキストは、複数行にわたって記述できます。 |
|
1094 .LP |
|
1095 .RS |
|
1096 .ft 3 |
|
1097 .nf |
|
1098 /** |
|
1099 * This is the typical format of a simple documentation comment |
|
1100 * that spans two lines. |
|
1101 */ |
|
1102 .fi |
|
1103 .ft 1 |
|
1104 .RE |
|
1105 .LP |
|
1106 次のように、コメントは 1 行にまとめることもできます。 |
|
1107 .LP |
|
1108 .RS |
|
1109 .ft 3 |
|
1110 .nf |
|
1111 /** This comment takes up only one line. */ |
|
1112 .fi |
|
1113 .ft 1 |
|
1114 .RE |
|
1115 .LP |
|
1116 コメントの配置 - ドキュメンテーションコメントが認識されるのは、クラス、 |
|
1117 インタフェース、コンストラクタ、メソッド、またはフィールド |
|
1118 宣言の前に置かれた場合だけです (クラス、メソッド、およびフィールドの |
|
1119 例を参照)。メソッドの本体に置かれたドキュメント |
|
1120 コメントは無視されます。 |
|
1121 .B javadoc |
|
1122 ツールは、宣言文ごとに 1 つのドキュメンテーションコメントだけを |
|
1123 認識します。 |
|
1124 .LP |
|
1125 よく発生する間違いは、重要な文をクラスコメントとクラス宣言の間に |
|
1126 入れてしまうことです。 |
|
1127 .B javadoc |
|
1128 はクラスコメントを無視するため、注意してください。 |
|
1129 .LP |
|
1130 .RS |
|
1131 .ft 3 |
|
1132 .nf |
|
1133 /** |
|
1134 * This is the class comment for the class Whatever. |
|
1135 */ |
|
1136 |
|
1137 import com.sun; // MISTAKE - Important not to put statements here |
|
1138 |
|
1139 public class Whatever { |
|
1140 } |
|
1141 .fi |
|
1142 .ft 1 |
|
1143 .RE |
|
1144 .LP |
|
1145 コメントの説明のあとにタグが続く - コメントの開始区切り文字である |
|
1146 .B /** |
|
1147 のあとからタグセクションまでが説明になります。 タグセクションは、 |
|
1148 先頭文字が |
|
1149 .B @ |
|
1150 である行から始まります (行の先頭のアスタリスクおよび空白文字 |
|
1151 は除く)。 説明を記述せず、コメントだけのタグを記述することもできます。 |
|
1152 説明は、タグセクション以降に続けることはできません。 |
|
1153 タグの引数は複数の行にまたがって記述できます。 タグの数に |
|
1154 制限はありません。何回も記述できるタグと、1 回しか記述できない |
|
1155 タグがあります。 次の例の |
|
1156 .B @see |
|
1157 からタグセクションが始まります。 |
|
1158 .LP |
|
1159 .nf |
|
1160 \f3 |
|
1161 .fl |
|
1162 /** |
|
1163 .fl |
|
1164 * This sentence would hold the main description for this doc comment. |
|
1165 .fl |
|
1166 * @see java.lang.Object |
|
1167 .fl |
|
1168 */ |
|
1169 .fl |
|
1170 \fP |
|
1171 .fi |
|
1172 |
|
1173 .LP |
|
1174 .LP |
|
1175 標準タグとインラインタグ: タグは、javadoc ツールが処理できる、 |
|
1176 doc コメント内の特別なキーワードです。javadoc ツールには、@tag として現れる |
|
1177 標準タグと、中括弧内に |
|
1178 .B {\f3@tag\f1} |
|
1179 として現れるインラインタグがあります。解釈 |
|
1180 させるためには、先頭のアスタリスク、空白、コメント区切り文字 (/**) を |
|
1181 除いては標準タグが行の先頭であるように配置する必要があります。つ |
|
1182 まり、ユーザはテキスト内の任意の位置で @ 文字を使用でき、 |
|
1183 この文字はタグの始めとは解釈されません。@ 文字で行を開 |
|
1184 始してこれが解釈されないようにしたい場合は、HTML エンティティの |
|
1185 @ を使用してください。各スタンドアロンタグには関連するテキストがあり |
|
1186 ます。これは、そのタグの後から次のタグの直前まで、または doc コメント |
|
1187 の最後までの任意のテキストです。関連付けられたテキストは、 |
|
1188 複数行にまたがって記述できます。 |
|
1189 インラインタグは、そのテキストが許 |
|
1190 可される位置にはどこでも指定でき、解釈の対象となります。次の例は、 |
|
1191 標準タグ |
|
1192 .BR @deprecated |
|
1193 とインラインタグ |
|
1194 .BR {@link} |
|
1195 が含まれています。 |
|
1196 .LP |
|
1197 .RS |
|
1198 .ft 3 |
|
1199 .nf |
|
1200 /** |
|
1201 * @deprecated As of JDk 1.1, replaced by {@link #setBounds(int,int,int,int)} |
|
1202 */ |
|
1203 .fi |
|
1204 .ft 1 |
|
1205 .RE |
|
1206 .LP |
|
1207 コメントは HTML で記述します。テキストは HTML で |
|
1208 記述しなければなりません。 |
|
1209 これは、HTML のエンティティを使う必要があること、 |
|
1210 および HTML タグを使用できること |
|
1211 を意味します。HTML は、使用するブラウザがサポートする |
|
1212 任意のバージョンを使うことが |
|
1213 できます。標準ドックレットは、階層式スタイルシートと |
|
1214 フレームを含むほかの部分 (ドキュメンテーションコメント |
|
1215 以外) は、HTML 3.2 に準拠したコードを生成するように記述 |
|
1216 されています |
|
1217 (フレームセット対応のため、生成される各 |
|
1218 ファイルは、「HTML 4.0」で始まる)。 |
|
1219 .LP |
|
1220 たとえば、より小さい (<) およびより大きい (>) という |
|
1221 記号は、 |
|
1222 .B < |
|
1223 と |
|
1224 .BR > |
|
1225 と記述する必要があります。同様に、アンパサンド (&) は、 |
|
1226 .BR & |
|
1227 と記述する必要があります。次の例で |
|
1228 は、ボールドの HTML タグ <b> を示します。 |
|
1229 .LP |
|
1230 次に doc コメントを示します。 |
|
1231 .LP |
|
1232 .RS |
|
1233 .ft 3 |
|
1234 .nf |
|
1235 /** |
|
1236 * This is a <b>doc</b> comment. |
|
1237 * @see java.lang.Object |
|
1238 */ |
|
1239 .fi |
|
1240 .ft 1 |
|
1241 .RE |
|
1242 .LP |
|
1243 行頭のアスタリスク - |
|
1244 .B javadoc |
|
1245 は、doc コメントを解析するときに、各行の先頭にある |
|
1246 文字アスタリスク (*) をすべて破棄し |
|
1247 ます。また、最初のアスタリスク (*) より前の空白と |
|
1248 タブも破棄します。1.4 からは、行頭のアスタリスクを省略した場合、行頭の空白は削除されません。これにより、<PRE> タグの中の doc コメントに、サンプルコードをインデントを残したままで直接ペーストすることができます。空白は一般的に、タブよりも均一にブラウザで解釈されます。インデントは、区切り文字 /** や <PRE> タグではなく、左マージンに相対的です。 |
|
1249 .LP |
|
1250 最初の文 - 各 doc コメントの最初の文は、宣言されている |
|
1251 エンティティに関する簡潔かつ完全 |
|
1252 な説明を含む要約文でなければなりません。 |
|
1253 この文は、空白、タブ、または行末記 |
|
1254 号が続いている最初のピリオド、あるいは最初のスタンドアロンタグで終了します。 |
|
1255 .B javadoc |
|
1256 ツールは、HTML ページの最初にあるメンバ要約に、この最初の文をコピーします。 |
|
1257 .LP |
|
1258 複数フィールドの宣言 - |
|
1259 .B java |
|
1260 では、単一の文で複数のフィールドを宣言できます。 |
|
1261 しかし、この文のドキュメンテ |
|
1262 ーションコメントは 1 つだけで、このコメントが |
|
1263 すべてのフィールドにコピーされます。 |
|
1264 したがって、フィールドごとに個々の |
|
1265 ドキュメンテーションコメントを付けたい場合は、 |
|
1266 各フィールドを異なる文で宣言しなければなりません。 |
|
1267 たとえば、次のドキュメンテー |
|
1268 ションコメントは単一の宣言としては意味を成さず、 |
|
1269 2 つの宣言として処理するべき |
|
1270 です。 |
|
1271 .LP |
|
1272 .RS |
|
1273 .ft 3 |
|
1274 .nf |
|
1275 /** |
|
1276 * The horizontal and vertical distances of point (x,y) |
|
1277 */ |
|
1278 public int x, y; // Avoid this |
|
1279 .fi |
|
1280 .ft 1 |
|
1281 .RE |
|
1282 .LP |
|
1283 .B javadoc |
|
1284 ツールは、上記コードから次のドキュメントを生成します。 |
|
1285 .LP |
|
1286 .RS |
|
1287 .ft 3 |
|
1288 public int x |
|
1289 .fi |
|
1290 .ft 1 |
|
1291 The horizontal and vertical distances of point |
|
1292 (x,y). |
|
1293 .ft 3 |
|
1294 .nf |
|
1295 public int y |
|
1296 .fi |
|
1297 .ft 1 |
|
1298 The horizontal and vertical distances of point |
|
1299 (x,y). |
|
1300 .RE |
|
1301 .LP |
|
1302 ヘッダタグを使用するときは注意してください。 |
|
1303 メンバ用のドキュメントコ |
|
1304 メントを書くときは、 |
|
1305 .B <H1> |
|
1306 や |
|
1307 .BR <H2> |
|
1308 などの HTML ヘッダタグを使用しないでください。これは、 |
|
1309 .B javadoc |
|
1310 が全ドキュメントを構造化して生成するため、 |
|
1311 これらの構造化タグを使用すると、 |
|
1312 ドキュメントの書式が乱れる可能性があるためです。 |
|
1313 しかし、クラスやパッケージの |
|
1314 コメントでは、これらのヘッダタグを使用して構造化を指示してください。 |
|
1315 .LP |
|
1316 メソッドコメントの自動コピー |
|
1317 .LP |
|
1318 .LP |
|
1319 Javadoc ツールには、次の 2 つの場合に、クラスおよびインタフェースのメソッドコメントをコピーまたは「継承」する機能があります。コンストラクタ、フィールド、および入れ子のクラスは、ドキュメンテーションコメントを継承しません。 |
|
1320 .LP |
|
1321 .RS 3 |
|
1322 .TP 2 |
|
1323 o |
|
1324 \f3自動的にコメントを継承して、見つからないテキストを埋める\fP \- 主説明または、\f2@return\fP、\f2@param\fP、\f2@throws\fP タグが、メソッドコメントで見つからない場合、Javadoc ツールは、オーバーライドしたメソッドまたは実装している場合はそのメソッドから、対応する主説明およびタグコメントを、次のアルゴリズムに従ってコピーします。 |
|
1325 .LP |
|
1326 厳密には、特定のパラメータの \f2@param\fP タグが見つからない場合、そのパラメータのコメントが、上位の継承階層のメソッドからコピーされます。特定の例外の \f2@throws\fP タグが見つからない場合、\f2その例外が宣言されている場合にかぎり\fP、その \f2@throws\fP タグがコピーされます。 |
|
1327 .LP |
|
1328 この動作はバージョン 1.3 以前の動作とは対照的です。これまでのバージョンでは、主説明またはタグが存在すれば、コメントは一切継承されませんでした。 |
|
1329 .TP 2 |
|
1330 o |
|
1331 \f3{@inheritDoc} タグを持つコメントを明示的に継承する\fP \- インラインタグ \f2{@inheritDoc}\fP を、メソッドの主説明、または \f2@return\fP、\f2@param\fP、\f2@throws\fP タグコメントに挿入します。継承した対応する主説明またはタグコメントは、その箇所にコピーされます。 |
|
1332 .RE |
|
1333 |
|
1334 .LP |
|
1335 .LP |
|
1336 ドキュメンテーションコメントを実際にコピーに利用するには、継承したメソッドのソースファイルが \-sourcepath で指定したパスだけに置かれていることが必要になります。コマンド行で、クラスもパッケージも渡す必要はありません。この点は、クラスが ドキュメント化されるクラスでなければならなかった 1.3.x 以前のリリースと異なります。 |
|
1337 .LP |
|
1338 .LP |
|
1339 \f3クラスおよびインタフェースからの継承\fP \- クラスおよびインタフェースから継承する次の 3 つの場合に、コメントの継承が行われます。 |
|
1340 .LP |
|
1341 .RS 3 |
|
1342 .TP 2 |
|
1343 o |
|
1344 クラスのメソッドがスーパークラスのメソッドをオーバーライドしている |
|
1345 .TP 2 |
|
1346 o |
|
1347 インタフェースのメソッドがスーパーインタフェースのメソッドをオーバーライドしている |
|
1348 .TP 2 |
|
1349 o |
|
1350 クラスのメソッドがインタフェースのメソッドを実装している |
|
1351 .RE |
|
1352 |
|
1353 .LP |
|
1354 .LP |
|
1355 最初の 2 つのケース (メソッドがオーバーライドしている場合) では、 |
|
1356 .B javadoc |
|
1357 ツールは、オーバーライドしているメソッドのドキュメント内に |
|
1358 「オーバーライド」という小見出しを生成し、コメントが継承されているかどうかにかかわらず、オーバーライドされている |
|
1359 メソッドへのリンクを書き込みます。 |
|
1360 .LP |
|
1361 3 つ目のケース (特定のクラスのメソッドがインタフェースの |
|
1362 メソッドを実装している場合) では、 |
|
1363 .B javadoc |
|
1364 ツールは、実装している |
|
1365 メソッドのドキュメント内に「定義」という小見出しを生成し、コメントが継承されているかどうかにかかわらず、 |
|
1366 実装されているメソッドへのリンクを書き込みます。 |
|
1367 .LP |
|
1368 メソッドの説明が継承されるアルゴリズム - あるメソッドに |
|
1369 ドキュメンテーションコメントが記述されていない場合、または {@inheritDoc} タグがある場合、 |
|
1370 .B javadoc |
|
1371 ツールは、次のようなアルゴリズムを使用して適切なコメントを検索します。 |
|
1372 このアルゴリズムは、もっとも適切なドキュメンテーションコメントを |
|
1373 検索できるように設計されており、スーパークラスよりも |
|
1374 インタフェースが優先されるようになっています。 |
|
1375 .TP 4 |
|
1376 1. |
|
1377 直接に実装されている (または、拡張されている) インタフェースを、 |
|
1378 メソッドの宣言で implements (または extends) キーワードのあとに |
|
1379 登場する順序で、1 つずつ調べる。 このメソッドについて |
|
1380 最初に見つかったドキュメンテーションコメントを採用する |
|
1381 .TP 4 |
|
1382 2. |
|
1383 手順 1 でドキュメンテーションコメントが見つからなかった場合は、 |
|
1384 直接実装されている (または、拡張されている) インタフェースの |
|
1385 それぞれに対して、このアルゴリズム全体を再帰的に適用する (その際の順序は、手順 1 でインタフェースを調べたときの順序と同じ) |
|
1386 .TP 4 |
|
1387 3. |
|
1388 手順 2 でドキュメンテーションコメントが見つからなかった場合で、 |
|
1389 このクラスが Object 以外のクラスである (インタフェースではない) 場合は、 |
|
1390 次のように処理する |
|
1391 .sp 1n |
|
1392 .nf |
|
1393 .ft 3 |
|
1394 a. スーパークラスにこのメソッドについてのドキュメンテーションコメントが記述されていれば、そのコメントを採用する |
|
1395 b. 手順 3a でドキュメンテーションコメントが見つからなかった場合は、スーパークラスに対して、このアルゴリズム全体を適用する |
|
1396 .ft 1 |
|
1397 .fi |
|
1398 .LP |
|
1399 .SS "javadoc のタグ" |
|
1400 .LP |
|
1401 .B javadoc |
|
1402 ツールは、 |
|
1403 .B java doc |
|
1404 コメント内に埋め込まれた特殊なタグを解析します。これらの |
|
1405 特殊な doc タグを使うと、 |
|
1406 書式の整った完全な API ドキュメントをソース |
|
1407 コードから自動的に生成できます。 |
|
1408 タグは、単価記号 (\f3@\f1) で始まり、大文字小文字が |
|
1409 区別されます。これらのタグは、 |
|
1410 以下に示すとおりに、大文字と小文字を区別して入力する |
|
1411 必要があります。タグは、行 |
|
1412 の先頭 (ただし先行する空白と省略可能なアスタリスクは除く) から |
|
1413 始めなければなり |
|
1414 ません。慣習上、同じ名前のタグは 1 個所にまとめて記述します。 |
|
1415 たとえば、 |
|
1416 .B @see |
|
1417 タグが複数ある場合は、すべてを 1 個所にまとめて記述します。 |
|
1418 .LP |
|
1419 タグは次の 2 種類あります。 |
|
1420 .LP |
|
1421 \(bu |
|
1422 スタンドアロンタグ - 説明のあとのタグセクションだけに |
|
1423 置くことができます。 このタグは、@tag のように中括弧で囲みません。 |
|
1424 .LP |
|
1425 \(bu |
|
1426 インラインタグ - コメントの説明内またはスタンドアロンタグの |
|
1427 コメント中の任意の場所に置くことができます。 インラインタグは、{@tag} の |
|
1428 ように中括弧で囲みます。 |
|
1429 .LP |
|
1430 今後のリリースで導入されるタグについては、 |
|
1431 .fi |
|
1432 http://java.sun.com/j2se/javadoc/proposed\-tags.html |
|
1433 の |
|
1434 .na |
|
1435 「\f2Proposed Tags\fP」を参照してください。 |
|
1436 .LP |
|
1437 .LP |
|
1438 現時点で有効なタグは、次のとおりです。 |
|
1439 .LP |
|
1440 .RS 3 |
|
1441 |
|
1442 .LP |
|
1443 .LP |
|
1444 .TS |
|
1445 center; |
|
1446 cbp-1 cbp-1 |
|
1447 l l. |
|
1448 タグ 導入された JDK/SDK のバージョン |
|
1449 @author 1.0 |
|
1450 {@code} 1.5 |
|
1451 {@docRoot} 1.3 |
|
1452 @deprecated} 1.0 |
|
1453 @exception 1.0 |
|
1454 {@inheritDoc} 1.4 |
|
1455 {@link} 1.2 |
|
1456 {@linkplain} 1.4 |
|
1457 {@literal} 1.5 |
|
1458 @param 1.0 |
|
1459 @return 1.0 |
|
1460 @see 1.0 |
|
1461 @serial 1.2 |
|
1462 @serialData 1.2 |
|
1463 @serialField 1.2 |
|
1464 @since 1.1 |
|
1465 @throws 1.2 |
|
1466 {@value} 1.4 |
|
1467 @version 1.0 |
|
1468 .TE |
433 .TE |
1469 .if \n-(b.=0 .nr c. \n(.c-\n(d.-42 |
434 .if \n-(b.=0 .nr c. \n(.c-\n(d.-42 |
1470 |
435 |
1471 .LP |
436 .LP |
1472 .LP |
437 .LP |
1473 カスタムタグについては、\-tag オプションを参照してください。 |
438 潟<潟阪絖 \f2/**\fP \f2/*\fP 荐菴違綽荀障筝茵茵≪鴻帥鴻ャ障障 |
1474 .TP |
439 .LP |
1475 .BI @author " name-text" |
440 .LP |
1476 .B \-author |
441 \f4package.html\fP \- <ゃ罨<罕宴若吾潟<潟主с障 潟<潟 \f2<body>\fP 荀膣臀障 |
1477 オプションが使われている場合、 |
442 .LP |
1478 生成されるドキュメントに、指定された |
443 .LP |
1479 name-text を持つ Author エントリを追加します。 |
444 File:\f2java/applet/package.html\fP |
1480 1 つの doc コメントに複数の |
445 .LP |
1481 .B @author |
446 .LP |
1482 タグを含めることができます。 |
447 .TS |
1483 .B @author |
448 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
1484 タグごとに 1 つ、またはタグごとに複数の名前を |
449 .de 35 |
1485 指定できます。前者の場合は、 |
450 .ps \n(.s |
1486 .B javadoc |
451 .vs \n(.vu |
1487 ツールは、名前と名前の間にコンマ (\f3,\f1) とスペースを挿入します。 |
452 .in \n(.iu |
1488 後者の場合、テキスト全体が |
453 .if \n(.u .fi |
1489 解析されることなく生成されるドキュメントにコピーされるだけです。 |
454 .if \n(.j .ad |
1490 このため、コンマ以外 |
455 .if \n(.j=0 .na |
1491 の現地仕様の名前区切り文字を使う場合は、1 行に複数の名前を指定します。 |
456 .. |
1492 .LP |
457 .nf |
1493 詳細については、「タグを使用できる場所」および |
458 .nr #~ 0 |
1494 .fi |
459 .if n .nr #~ 0.6n |
1495 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@author |
460 .ds #d .d |
1496 の |
461 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
462 .fc |
|
463 .nr 33 \n(.s |
|
464 .rm 80 |
|
465 .nr 34 \n(.lu |
|
466 .eo |
|
467 .am 80 |
|
468 .br |
|
469 .di a+ |
|
470 .35 |
|
471 .ft \n(.f |
|
472 .ll \n(34u*1u/2u |
|
473 .if \n(.l<\n(80 .ll \n(80u |
|
474 .in 0 |
|
475 .nf |
|
476 \f3 |
|
477 .fl |
|
478 <HTML> |
|
479 .fl |
|
480 <BODY> |
|
481 .fl |
|
482 Provides the classes necessary to create an applet and the |
|
483 .fl |
|
484 classes an applet uses to communicate with its applet context. |
|
485 .fl |
|
486 <p> |
|
487 .fl |
|
488 The applet framework involves two entities: the applet |
|
489 .fl |
|
490 and the applet context. An applet is an embeddable |
|
491 .fl |
|
492 window (see the {@link java.awt.Panel} class) with a |
|
493 .fl |
|
494 few extra methods that the applet context can use to |
|
495 .fl |
|
496 initialize, start, and stop the applet. |
|
497 .fl |
|
498 |
|
499 .fl |
|
500 @since 1.0 |
|
501 .fl |
|
502 @see java.awt |
|
503 .fl |
|
504 </BODY> |
|
505 .fl |
|
506 </HTML> |
|
507 .fl |
|
508 \fP |
|
509 .fi |
|
510 .br |
|
511 .di |
|
512 .nr a| \n(dn |
|
513 .nr a- \n(dl |
|
514 .. |
|
515 .ec \ |
|
516 .35 |
|
517 .nf |
|
518 .ll \n(34u |
|
519 .nr 80 0 |
|
520 .80 |
|
521 .rm 80 |
|
522 .nr 38 \n(a- |
|
523 .if \n(80<\n(38 .nr 80 \n(38 |
|
524 .35 |
|
525 .nf |
|
526 .ll \n(34u |
|
527 .nr 38 1n |
|
528 .nr 79 0 |
|
529 .nr 40 \n(79+(0*\n(38) |
|
530 .nr 80 +\n(40 |
|
531 .nr TW \n(80 |
|
532 .if t .if \n(TW>\n(.li .tm Table at line 406 file Input is too wide - \n(TW units |
|
533 .fc |
|
534 .nr #T 0-1 |
|
535 .nr #a 0-1 |
|
536 .eo |
|
537 .de T# |
|
538 .ds #d .d |
|
539 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
540 .mk ## |
|
541 .nr ## -1v |
|
542 .ls 1 |
|
543 .ls |
|
544 .. |
|
545 .ec |
|
546 .ne \n(a|u+\n(.Vu |
|
547 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
548 .ta \n(80u |
|
549 .nr 31 \n(.f |
|
550 .nr 35 1m |
|
551 \&\h'|\n(40u' |
|
552 .mk ## |
|
553 .nr 31 \n(## |
|
554 .sp |\n(##u-1v |
|
555 .nr 37 \n(40u |
|
556 .in +\n(37u |
|
557 .a+ |
|
558 .in -\n(37u |
|
559 .mk 32 |
|
560 .if \n(32>\n(31 .nr 31 \n(32 |
|
561 .sp |\n(31u |
|
562 .fc |
|
563 .nr T. 1 |
|
564 .T# 1 |
|
565 .35 |
|
566 .rm a+ |
|
567 .TE |
|
568 .if \n-(b.=0 .nr c. \n(.c-\n(d.-40 |
|
569 |
|
570 .LP |
|
571 .LP |
|
572 絽吾 HTML <ゃс宴若後hс鴻羈宴若吾潟<潟<ゃ絎鴻祉鴻潟<潟罕 HTML ц菴違障ャ<潟若激с潟潟<潟潟<潟阪絖с \f2/**\fP \f2*/\fP活≪鴻帥鴻с潟<潟吾翫宴若吾网荀\f2<body>\fP 帥ゃ篁鴻障宴若吾帥違с障祉ャ<潟若激с潟潟<潟罕鴻帥違筝肢臀違障宴若吾潟<潟<ゃ \f2@see\fP 帥違菴遵翫絎絎篏睡綽荀障荅括完 |
1497 .na |
573 .na |
1498 \f2@author タグのドキュメント\fPを参照してください。 |
574 \f2package.html\fP 箴 @ |
1499 .LP |
575 .fi |
|
576 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#packagecommentsс |
|
577 .LP |
|
578 .LP |
|
579 \f3宴若吾潟<潟<ゃ\fP \- Javadoc 若絎茵宴若吾潟<潟<ゃ罎膣≪<ゃ荀ゃ罨<茵障 |
|
580 .LP |
|
581 .RS 3 |
|
582 .TP 2 |
|
583 o |
|
584 с潟<潟潟若 (\f2package.html\fP 翫с違\f2<body>\fP \f2</body>\fP HTML 帥違絎鴻鴻潟若\f2<head>\fP \f2<title>\fP 純若鴻<ゃ篏罔荐菴違宴臀с緇ャ<潟若激с潟筝茵腓冴) |
|
585 .TP 2 |
|
586 o |
|
587 宴若吾帥違違鴻 |
|
588 .TP 2 |
|
589 o |
|
590 宴若吾网荀若吾緇鴻水ャ (箴: |
|
591 .na |
|
592 \f2宴若吾网荀\fP @ |
|
593 .fi |
|
594 http://java.sun.com/javase/6/docs/api/java/applet/package\-summary.html) |
|
595 .TP 2 |
|
596 o |
|
597 宴若吾网荀若吾宴若吾潟<潟潟若网荀若吾宴若吾鴻宴若後宴若吾潟<潟菴遵 (箴: |
|
598 .na |
|
599 \f2网荀荀膣\fP @ |
|
600 .fi |
|
601 http://java.sun.com/javase/6/docs/api/overview\-summary.html)絨障鴻<潟若筝肢絨障荀cゆ |
|
602 .RE |
|
603 |
|
604 .LP |
|
605 .SS |
|
606 网荀潟<潟<ゃ |
|
607 .LP |
|
608 .LP |
|
609 ャ<潟≪宴若激с潟障宴若吾祉网荀ャ<潟若激с潟潟<潟ゃс絨純若鴻<ゃ篆障 絎鴻Javadoc 若c网荀若吾腟粋昭障障潟<潟絽吾≪宴若激с潟障宴若吾祉篏綵障ャ<潟荐菴違障 |
|
610 .LP |
|
611 .LP |
|
612 网荀潟<潟<ゃ篏翫<ゃ篁紙篁篁紙贋臀с障絽吾<ゃ \f4overview.html\fP 純若鴻若筝篏臀障違\f2java.applet\fP 宴若吾純若鴻<ゃ \f2/home/user/src/java/applet\fP c障翫\f2/home/user/src/overview.html\fP 网荀潟<潟<ゃ篏с障 |
|
613 .LP |
|
614 .LP |
|
615 違宴若吾祉絲障 javadoc 茲医絎茵翫 1 ゃ純若鴻<ゃ祉絲障茲違网荀潟<潟<ゃ篏с障違ャ<潟若激с括 \-private 絎 javadoc 1 絎茵ャ<潟若激с括激с潟絎у綺絎茵с障翫网荀潟<潟<ゃ 1 сャ<潟若激с潟障荐菴違с障 |
|
616 .LP |
|
617 .LP |
|
618 网荀潟<潟<ゃ絎鴻菴違宴若吾潟<潟<ゃ罕HTML ц菴違 1 ゃ紊сャ<潟若激с潟潟<潟с荅括完菴違茯с荀鴻膵違菴潟<潟荐菴違翫≪宴若激с潟障宴若吾祉荀膣\f2<body>\fP 帥ゃ篁鴻障网荀帥違с障 ャ<潟若激с潟潟<潟ゃゃ潟ゃ潟帥 (\f2{@link}\fP ) 篁ュ鴻帥違筝肢臀鏆荀障\f2@see\fP 帥違菴遵翫絎絎篏睡違障 |
|
619 .LP |
|
620 .LP |
|
621 Javadoc 若絎茵\-overview 激с潟篏帥c网荀潟<潟<ゃ絎障<ゃ宴若吾潟<潟<ゃ障 |
|
622 .LP |
|
623 .RS 3 |
|
624 .TP 2 |
|
625 o |
|
626 \f2<body>\fP 帥違 \f2</body>\fP 帥違鴻絎鴻潟若 |
|
627 .TP 2 |
|
628 o |
|
629 网荀帥違違鴻 |
|
630 .TP 2 |
|
631 o |
|
632 网荀若吾緇鴻水ャ (箴: |
|
633 .na |
|
634 \f2网荀荀膣\fP @ |
|
635 .fi |
|
636 http://java.sun.com/javase/6/docs/api/overview\-summary.html) |
|
637 .TP 2 |
|
638 o |
|
639 网荀若吾网荀潟<潟潟若 |
|
640 .RE |
|
641 |
|
642 .LP |
|
643 .SS |
|
644 篁<ゃ |
|
645 .LP |
|
646 .LP |
|
647 純若鴻Javadoc 若cc潟若篁篁紙<ゃс障筝<ゃ違c<ゃ泣潟 Java 純若 (.java) 潟 (.class) <ゃ絎鴻絽吾 Java 純若鴻<ゃャ<潟若激с潟潟<潟綵演帥腴 HTML <ゃ障 |
|
648 .LP |
|
649 .LP |
|
650 <ゃ純若鴻<ゃ \f4doc\-files\fP c臀障 c純若鴻<ゃ篁紙宴若吾c筝篏с障泣c宴若吾 1 ょс障ゃ<若吾泣潟潟若純若鴻<ゃ.class <ゃ≪ HTML <ゃc主с障違帥潟ゃ<若 \f2button.gif\fP \f2java.awt.Button\fP 鴻ャ<潟翫<ゃ \f2/home/user/src/java/awt/doc\-files/\fP c臀障\f2doc\-files\fP c \f2/home/user/src/java/doc\-files\fP 臀с障 \f2java\fP 宴若吾сc純若鴻<ゃャcс |
|
651 .LP |
|
652 .LP |
|
653 <ゃ吾潟鴻腓榊荐菴違綽荀障 Javadoc 若<ゃ荀c絎鴻潟若с違\f2Button.java\fP ャ<潟若激с潟潟<潟潟罨<障 |
|
654 .LP |
|
655 .nf |
|
656 \f3 |
|
657 .fl |
|
658 /** |
|
659 .fl |
|
660 * This button looks like this: |
|
661 .fl |
|
662 * <img src="doc\-files/Button.gif"> |
|
663 .fl |
|
664 */ |
|
665 .fl |
|
666 \fP |
|
667 .fi |
|
668 |
|
669 .LP |
|
670 .SS |
|
671 鴻<ゃ潟潟若<ゃ |
|
672 .LP |
|
673 .LP |
|
674 筝肴鴻<ゃ潟潟若<ゃ絲上純若鴻<ゃ菴純若鴻若篆絖荀障ゃ障純若鴻<ゃc障泣c篆絖с |
|
675 .LP |
|
676 .LP |
|
677 ャ純若鴻<ゃф腓榊羝< Javadoc 若絎茵翫鴻<ゃ潟潟若<ゃ括ゅс障宴若後障ゃ若ф検翫篁ヤ若緇c鴻<ゃ潟潟若<ゃ綽荀障 |
|
678 .LP |
|
679 .LP |
|
680 鴻<ゃ潟若<ゃ鴻<ゃ罩eс潟潟ゃ純純若鴻<ゃс絲障潟若<ゃс鴻с 潟若<ゃ.javaхс障 |
|
681 .LP |
|
682 .LP |
|
683 \f3鴻<ゃ\fP \- 肴紊宴若吾潟潟ゃ純у茵純鴻<ゃ宴若吾純若鴻<ゃc臀障鴻<ゃ宴若吾純若鴻<ゃ宴若吾ャ宴若吾絮障 (鴻<ゃ package 鴻若<潟障純若鴻ャ package 鴻若<潟)倶с潟潟茵ф絎純若鴻宴若後絎純若鴻ャ<潟鴻<ゃ茘障若綣莎激障鴻<ゃ泣c臀綽荀障\f2com.package1\fP 菴遵翫鴻<ゃゃ潟障宴若後≦鴻泣c臀障 |
|
684 .LP |
|
685 .nf |
|
686 \f3 |
|
687 .fl |
|
688 com/package1/test\-files/ |
|
689 .fl |
|
690 \fP |
|
691 .fi |
|
692 |
|
693 .LP |
|
694 .LP |
|
695 Javadoc 若с茘 test c鴻障 |
|
696 .LP |
|
697 .LP |
|
698 鴻<ゃ doc 潟<潟障翫罨<ゃ若鴻純若鴻<ゃф検鴻<ゃャ<潟Javadoc 若ュ絎茵с荐絎с障 違\f2com/package1/test\-files/*.java\fP с |
|
699 .LP |
|
700 .LP |
|
701 \f3純若鴻<ゃ潟若\fP \- 潟若<ゃ.javaх障潟若<ゃ潟潟ゃс障純若鴻c篆純若鴻<ゃ潟若翫<ゃゃ (\f2Buffer\-Template.java\fP ) 篁筝罩c Java 絖篏睡障 с障Javadoc 若.java・絨乗ゃ 罩h劫с純若鴻<ゃсс ( |
|
702 .na |
|
703 \f2茘ュ\fP @ |
|
704 .fi |
|
705 http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625) |
|
706 .LP |
|
707 .SH "<ゃ" |
|
708 .LP |
|
709 .LP |
|
710 сjavadoc 若HTML 綵√ャ<潟罔羣篏帥障篁ヤ腮蕁<ゃ障 HTML 若吾<ゃ後障javadoc <ゃ鴻ゃ潟帥с若鴻<с (\f2package\-summary.html\fP ) 2 腮蕁障緇違若<ゃ違若<ゃ腴九ゃ潟障障 |
|
711 .LP |
|
712 .LP |
|
713 \f3堺絎鴻若\fP |
|
714 .LP |
|
715 .RS 3 |
|
716 .TP 2 |
|
717 o |
|
718 ャ<潟鴻障ゃ潟帥с若鴻 1 ゃ\f3鴻若吾障ゃ潟帥с若鴻若\fP (\f2劫\fP\f2.html\fP) |
|
719 .TP 2 |
|
720 o |
|
721 ャ<潟宴若吾 1 ゃ\f3宴若吾若\fP (\f2package\-summary.html\fP)Javadoc 若純若鴻若宴若吾c \f2package.html\fP 障 \f2package\-info.java\fP <ゃ違筝 HTML 鴻若吾腟水ャ障 |
|
722 .TP 2 |
|
723 o |
|
724 宴若吾祉篏絲障 1 ゃ\f3网荀若\fP (\f2overview\-summary.html\fP)ャ<潟若吾障Javadoc 若\f2\-overview\fP 激с潟ф絎<ゃ HTML 鴻若吾腟水ャ障若吾<ゃjavadoc 茲違宴若後羝<翫篏障荅括完HTML 若с |
|
725 .RE |
|
726 |
|
727 .LP |
|
728 .LP |
|
729 \f3娯с若\fP |
|
730 .LP |
|
731 .RS 3 |
|
732 .TP 2 |
|
733 o |
|
734 \f3宴若吾祉篏絲障 1 ゃ拷絮ゃ若\fP (\f2overview\-tree.html\fP)若吾茵腓冴蚊若激с潟若 [网荀] [絮ゃ] 障 |
|
735 .TP 2 |
|
736 o |
|
737 \f3宴若吾 1 ゃ拷絮ゃ若\fP (\f2package\-tree.html\fP) 劫宴若吾鴻障ゃ潟帥с若鴻若吾茵腓冴[絮ゃ] 宴若吾拷絮ゃ茵腓冴障 |
|
738 .TP 2 |
|
739 o |
|
740 \f3宴若吾 1 ゃ [篏睡] 若\fP (\f2package\-use.html\fP)\f3鴻潟ゃ潟帥с若鴻 1 ゃゃ [篏睡] 若\fP (\f2class\-use/\fP\f2劫\fP\f2.html\fP)若吾劫鴻ゃ潟帥с若鴻障宴若吾筝篏帥c宴若吾鴻<純潟潟鴻帥潟c若ゃ荐菴違障鴻障ゃ潟帥с若 A 箴 [篏睡] 若吾A 泣鴻A 絎hc若A 菴<純A <若帥ゃ<純潟潟潟鴻帥茵腓冴障 若吾茵腓冴障宴若吾鴻障ゃ潟帥с若鴻若吾腱糸蚊若激с潟若 [篏睡] 潟障 |
|
741 .TP 2 |
|
742 o |
|
743 \f3ィ絅 API 若\fP (\f2deprecated\-list.html\fP) ィ絅鴻筝荀ц;腓冴障ィ絅筝壕 API 絖篏睡ィ絅 API с絽吾臀腓冴障ィ絅 API 絨ャ絎茖сゃ醇с障 |
|
744 .TP 2 |
|
745 o |
|
746 \f3絎違c若ゃ若\fP (\f2constant\-values.html\fP) static c若ょс |
|
747 .TP 2 |
|
748 o |
|
749 \f3翫若若\fP (\f2serialized\-form.html\fP) 翫喝純鴻с鴻翫c若潟<純≪茯障宴API 篏帥肴с絎茖茵肴綽荀宴с蚊若激с潟若若吾吾潟障翫鴻腱糸鴻茯 [∫i] 祉激с潟 [翫綵√] 宴緇с障罔羣翫綵√若吾障Serializable 絎茖 public 障 public 鴻腟粋昭障\f2readObject\fP <純\f2writeObject\fP <純翫c若 \f2@serial\fP 帥違\f2@serialField\fP 帥違\f2@serialData\fP 帥違ャ<潟若激с潟潟<潟腟粋昭障障翫純 public 鴻ゅ鴻障鴻絮宴若吾 \f2@serial exclude\fP 帥違ф絎障 翫純 package private 鴻鴻障鴻絮宴若吾 \f2@serial include\fP 帥違ф絎障若吾с 1.4 с\f2\-private\fP 激с潟絎 javadoc 若絎茵public 鴻 private 鴻絎翫鴻с障 |
|
750 .TP 2 |
|
751 o |
|
752 \f3膣√\fP (\f2index\-*.html\fP) 鴻劫ゃ潟帥с若劫潟潟鴻水c若潟<純≪<筝с障膣√Unicode 宴初障 1 ゃ<ゃ絖 (沿翫 A Z) ャ<ゃс障 |
|
753 .RE |
|
754 |
|
755 .LP |
|
756 .LP |
|
757 \f3泣若<ゃ\fP |
|
758 .LP |
|
759 .RS 3 |
|
760 .TP 2 |
|
761 o |
|
762 \f3若\fP (\f2help\-doc.html\fP) 蚊若激с潟若菴違若吾≪茯荐莠障\f2\-helpfile\fP 篏帥<ゃ篁c鴻帥<ゃ箴с障 |
|
763 .TP 2 |
|
764 o |
|
765 茵腓榊 HTML 若篏 1 ゃ \f3index.html <ゃ\fP<ゃ若篁若吾茵腓冴翫若障<ゃ篏鴻絎鴻障障 |
|
766 .TP 2 |
|
767 o |
|
768 茲違\f3若<ゃ\fP (\f2*\-frame.html\fP) 宴若吾鴻潟ゃ潟帥с若鴻鴻障障 HTML 若茵腓冴篏睡障 |
|
769 .TP 2 |
|
770 o |
|
771 \f3宴若吾鴻\fP<ゃ (\f2package\-list\fP) \f2\-link\fP 激с潟 \f2\-linkoffline\fP 激с潟т戎障HTML <ゃс鴻<ゃс潟≪祉鴻с障 |
|
772 .TP 2 |
|
773 o |
|
774 \f3鴻帥ゃ激若\fP<ゃ (\f2stylesheet.css\fP) 若娯ゃ荀膣ゃ蚊潟<潟泣ゃ冴潟鴻帥ゃ渇臀九勝障 |
|
775 .TP 2 |
|
776 o |
|
777 \f3doc\-files\fP c c潟若ゃ<若吾泣潟潟若純若鴻潟若<ゃ鴻主障<ゃJavadoc 若c<ゃ javadoc 帥違c∴障c純若鴻若筝翫睡障 |
|
778 .RE |
|
779 |
|
780 .LP |
|
781 .LP |
|
782 \f3HTML 若\fP |
|
783 .LP |
|
784 .LP |
|
785 Javadoc 若筝潟腓冴2 3 ゃ HTML 若障1 ゃ宴若吾翫 (障宴若吾翫) 宴若吾筝荀сャc篏綽荀違若篏障筝宴若吾絮純若鴻<ゃ (*.java) 障筝宴若後綣違 javadoc 潟潟羝<翫綏眼鴻筝荀с茵腓冴若 (C) 1 ゃ篏障Javadoc 茲違宴若後羝<翫网荀若 (Detail) 鴻宴若吾筝荀ц;腓冴膃 3 若 (P) 篏障网荀若吾<ゃ\f2overview\-summary.html\fP сc<ゃ2 や札筝宴若後羝<翫篏障[若] 潟overview\-summary.html 茵腓冴若ャс障 |
|
786 .LP |
|
787 .LP |
|
788 HTML 若c翫劫若医激潟鴻若若若鴻違羈若若鴻筝若障紊吟с√違若若吾若篏帥c若鴻若[医] <ャ若潟潟篏帥c若医激с障 |
|
789 .LP |
|
790 .nf |
|
791 \f3 |
|
792 .fl |
|
793 \-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\- |
|
794 .fl |
|
795 |C| Detail | |P| Detail | |
|
796 .fl |
|
797 | | | | | | |
|
798 .fl |
|
799 | | | |\-| | |
|
800 .fl |
|
801 | | | |C| | |
|
802 .fl |
|
803 | | | | | | |
|
804 .fl |
|
805 | | | | | | |
|
806 .fl |
|
807 \-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\- |
|
808 .fl |
|
809 javadoc *.java javadoc java.lang java.awt |
|
810 .fl |
|
811 \fP |
|
812 .fi |
|
813 |
|
814 .LP |
|
815 .LP |
|
816 HTML 若綽荀c罨<<<ゃ紮若吾若障 |
|
817 .LP |
|
818 .RS 3 |
|
819 .TP 2 |
|
820 o |
|
821 \f2index.html\fP (若) |
|
822 .TP 2 |
|
823 o |
|
824 \f2overview\-summary.html\fP (若) |
|
825 .RE |
|
826 |
|
827 .LP |
|
828 .LP |
|
829 \f3<ゃ罕\fP |
|
830 .LP |
|
831 .LP |
|
832 鴻<ゃ潟ゃ潟帥с若鴻<ゃJava 純若鴻<ゃ潟鴻<ゃc絮ゃ膩障1 ゃ泣宴若吾ゃ 1 ゃc罕障 |
|
833 .LP |
|
834 .LP |
|
835 違\f2java.applet.Applet\fP 鴻絲障ャ<潟\f2java/applet/Applet.html\fP 主障c \f2apidocs\fP java.applet 宴若吾<ゃ罕筝罕膀障菴違frame茯<ゃ鴻綏筝障綏筝若茵腓冴障篁ュ HTML <ゃ鴻勀眼若茵腓冴障 |
|
836 .LP |
|
837 .RS 3 |
|
838 |
|
839 .LP |
|
840 .LP |
|
841 羈 \- 筝絮ゅ潟сc\f3紊絖\fP (\f3bold\fP) хず障≪鴻帥鴻 (\f2*\fP) javadoc 吾綣違宴若後с純若鴻<ゃ (*.java) с翫ャ<ゃ潟c腓冴障障綣違純若鴻<ゃ翫\f2package\-list\fP 篏障絎鴻腥冴сdoc\-files c純若鴻弱絖翫帥篏障 |
|
842 .LP |
|
843 .RE |
|
844 .nf |
|
845 \f3 |
|
846 .fl |
|
847 |
|
848 .fl |
|
849 \fP\f3apidocs\fP 筝篏c |
|
850 .fl |
|
851 index.html HTML 若荐絎若 |
|
852 .fl |
|
853 * overview\-summary.html 宴若吾鴻 荀膣 |
|
854 .fl |
|
855 overview\-tree.html 宴若吾拷絮ゃ鴻 |
|
856 .fl |
|
857 deprecated\-list.html 宴若吾ィ絅 API 鴻 |
|
858 .fl |
|
859 constant\-values.html 宴若吾 static c若ゃ鴻 |
|
860 .fl |
|
861 serialized\-form.html 宴若吾翫綵√鴻 |
|
862 .fl |
|
863 * overview\-frame.html 宴若吾鴻 綏筝若茵腓冴 |
|
864 .fl |
|
865 allclasses\-frame.html 宴若吾鴻鴻 綏筝若茵腓冴 |
|
866 .fl |
|
867 help\-doc.html 若吾罕腓冴若吟若茵腓冴 |
|
868 .fl |
|
869 index\-all.html \-splitindex 激с潟т膣√ |
|
870 .fl |
|
871 \f3index\-files\fP \-splitindex 激с潟絎篏c |
|
872 .fl |
|
873 index\-<number>.html \-splitindex 激с潟絎篏膣√<ゃ |
|
874 .fl |
|
875 package\-list 宴若後鴻 紊с茹f浦篏睡 |
|
876 .fl |
|
877 stylesheet.css 潟蚊臀絎臂 HTML 鴻帥ゃ激若 |
|
878 .fl |
|
879 \f3java\fP 宴若吾c |
|
880 .fl |
|
881 \f3applet\fP 泣宴若吾c |
|
882 .fl |
|
883 Applet.html Applet 鴻若 |
|
884 .fl |
|
885 AppletContext.html AppletContext ゃ潟帥с若鴻若 |
|
886 .fl |
|
887 AppletStub.html AppletStub ゃ潟帥с若鴻若 |
|
888 .fl |
|
889 AudioClip.html AudioClip ゃ潟帥с若鴻若 |
|
890 .fl |
|
891 * package\-summary.html 宴若吾鴻鴻 荀膣 |
|
892 .fl |
|
893 * package\-frame.html 宴若吾鴻鴻 綏筝若茵腓冴 |
|
894 .fl |
|
895 * package\-tree.html 宴若吾拷絮ゃ鴻 |
|
896 .fl |
|
897 package\-use 宴若吾篏睡贋鴻 |
|
898 .fl |
|
899 \f3doc\-files\fP ゃ<若吾泣潟<ゃ主c |
|
900 .fl |
|
901 \f3class\-use\fP API 篏睡贋若吾主c |
|
902 .fl |
|
903 Applet.html Applet 鴻篏睡若 |
|
904 .fl |
|
905 AppletContext.html AppletContext ゃ潟帥с若鴻篏睡若 |
|
906 .fl |
|
907 AppletStub.html AppletStub ゃ潟帥с若鴻篏睡若 |
|
908 .fl |
|
909 AudioClip.html AudioClip ゃ潟帥с若鴻篏睡若 |
|
910 .fl |
|
911 \f3src\-html\fP 純若鴻潟若c |
|
912 .fl |
|
913 \f3java\fP 宴若吾c |
|
914 .fl |
|
915 \f3applet\fP 泣宴若吾c |
|
916 .fl |
|
917 Applet.html Applet 純若鴻潟若若 |
|
918 .fl |
|
919 AppletContext.html AppletContext 純若鴻潟若若 |
|
920 .fl |
|
921 AppletStub.html AppletStub 純若鴻潟若若 |
|
922 .fl |
|
923 AudioClip.html AudioClip 純若鴻潟若若 |
|
924 .fl |
|
925 .fi |
|
926 |
|
927 .LP |
|
928 .SS |
|
929 API 絎h |
|
930 .LP |
|
931 .LP |
|
932 Javadoc 若鴻ゃ潟帥с若鴻c若潟潟鴻帥潟<純茯 API 絎h障 絎h API 絎hс違\f2Boolean\fP 鴻絎h罨<障 |
|
933 .LP |
|
934 .LP |
|
935 \f2public final class Boolean\fP |
|
936 .br |
|
937 \f2extends Object\fP |
|
938 .br |
|
939 \f2implements Serializable\fP |
|
940 .LP |
|
941 .LP |
|
942 障\f2Boolean.valueOf\fP <純絎h罨<障 |
|
943 .LP |
|
944 .LP |
|
945 \f2public static Boolean valueOf(String s)\fP |
|
946 .LP |
|
947 .LP |
|
948 Javadoc 若篆蕋上 \f2public\fP\f2protected\fP\f2private\fP\f2abstract\fP\f2final\fP\f2static\fP\f2transient\fP \f2volatile\fP 腟粋昭с障\f2synchronized\fP \f2native\fP 腟粋昭с障緇 2 ゃ篆蕋上絎茖荅括完荀API 篁罕障障 |
|
949 .LP |
|
950 .LP |
|
951 API с筝茵с祉潟c鴻ゃ若若 \f2synchronized\fP 箴絖с潟<潟筝肢ャ<潟綽荀障 違1 ゃ \f2Enumeration\fP 茲違鴻筝茵篏睡с潟<潟荐菴違障ャ<潟祉潟c鴻絎憗号荐菴違鴻с障違\f2Hashtable\fP 鴻絲障絎с綽荀障鴻若鴻<純違絎憗с絎号障宴у罔罧鏆荀障 違蕭綺筝茵с箴障 |
|
952 .LP |
|
953 .SH "ャ<潟若激с潟潟<潟" |
|
954 .LP |
|
955 .LP |
|
956 吾ャ<潟若激с潟潟<潟篁罕∫iс |
|
957 .LP |
|
958 .SS |
|
959 純若鴻潟若吾潟<潟水 |
|
960 .LP |
|
961 .LP |
|
962 純若鴻潟若篁紙鴻ゃ潟帥с若鴻<純潟潟鴻帥障c若絎hャ<潟若激с潟潟<潟 ("doc comments") 荐菴違с障宴若吾ャ<潟若激с潟潟<潟篏с障 罕ュ慌違障网荀ャ<潟若激с潟潟<潟篏с障ャ<潟若激с潟潟<潟綣Javadoc 潟<潟若違障 (茯罔∫c篏睡羈)ャ<潟若激с潟潟<潟潟<潟紮障腓冴絖 \f2/**\fP 潟<潟腟腓冴絖 \f2*/\fP 絖ф障茵≪鴻帥鴻茵荐菴違с障 荅括完篁ヤц障潟<潟鴻茲域c荐菴違с障 |
|
963 .LP |
|
964 .nf |
|
965 \f3 |
|
966 .fl |
|
967 /** |
|
968 .fl |
|
969 * This is the typical format of a simple documentation comment |
|
970 .fl |
|
971 * that spans two lines. |
|
972 .fl |
|
973 */ |
|
974 .fl |
|
975 \fP |
|
976 .fi |
|
977 |
|
978 .LP |
|
979 .LP |
|
980 罨< 1 茵荐菴違鴻若鴻膀膣с障 |
|
981 .LP |
|
982 .nf |
|
983 \f3 |
|
984 .fl |
|
985 /** This comment takes up only one line. */ |
|
986 .fl |
|
987 \fP |
|
988 .fi |
|
989 |
|
990 .LP |
|
991 .LP |
|
992 \f3潟<潟臀\fP \- ャ<潟若激с潟潟<潟鴻ゃ潟帥с若鴻潟潟鴻帥<純障c若絎h翫臀茯茘障 鴻箴<純箴潟c若箴с<純篏臀ャ<潟若激с潟潟<潟∴障javadoc 若с1 ゃ絎hゃ 1 ゃャ<潟若激с潟潟<潟茯茘障 |
|
993 .LP |
|
994 .LP |
|
995 鴻潟<潟鴻絎h \f2import\fP 臀障с荐菴違с 鴻潟<潟∴障 |
|
996 .LP |
|
997 .nf |
|
998 \f3 |
|
999 .fl |
|
1000 /** |
|
1001 .fl |
|
1002 * This is the class comment for the class Whatever. |
|
1003 .fl |
|
1004 */ |
|
1005 .fl |
|
1006 |
|
1007 .fl |
|
1008 import com.sun; // MISTAKE \- Important not to put import statement here |
|
1009 .fl |
|
1010 |
|
1011 .fl |
|
1012 public class Whatever { |
|
1013 .fl |
|
1014 } |
|
1015 .fl |
|
1016 \fP |
|
1017 .fi |
|
1018 |
|
1019 .LP |
|
1020 .LP |
|
1021 \f3ャ<潟若激с潟潟<潟筝肢帥違祉激с潟膓\fP \- 潟<潟紮阪絖с \f2/**\fP 帥違祉激с潟障с筝肢障帥違祉激с潟絖 \f2@\fP с茵у臂帥違紮障障 (茵≪鴻帥鴻腥榊純活阪絖 \f2/**\fP ゃ)筝肢荐菴違帥違祉激с潟潟<潟荐菴違с障筝肢帥違祉激с割札膓с障帥違綣違茲域c荐菴違с障帥違違狗障 篏荐菴違с帥違1 荐菴違с帥違障箴違罨< \f2@see\fP 帥違祉激с潟紮障障 |
|
1022 .LP |
|
1023 .nf |
|
1024 \f3 |
|
1025 .fl |
|
1026 /** |
|
1027 .fl |
|
1028 * This sentence would hold the main description for this doc comment. |
|
1029 .fl |
|
1030 * @see java.lang.Object |
|
1031 .fl |
|
1032 */ |
|
1033 .fl |
|
1034 \fP |
|
1035 .fi |
|
1036 |
|
1037 .LP |
|
1038 .LP |
|
1039 \f3帥違ゃ潟ゃ潟帥\fP \- 帥違Javadoc сャ<潟若激с潟潟<潟劫ャ若若с\f2@tag\fP 荐菴違帥 (鴻帥潟≪潟帥違若違) ゃ潟ゃ潟帥 (\f2{@tag}\fP 筝綣су蚊ц菴) 2 腮蕁帥違障帥違罩c頵i茵≪鴻帥鴻腥榊純阪絖 (\f2/**\fP) ゃ茵臀違障鴻篁ュ篏臀 \f2@\fP 絖篏睡帥違紮茹i潟障茵 \f2@\fP 絖篏睡帥違茹iHTML 潟cc若\f2@\fP篏睡帥違絲上篁鴻障 鴻帥違罨<帥違障ャ<潟若激с潟潟<潟緇障с荐菴違鴻 (帥違潟<潟阪絖ゃ) с∫c鴻茲域c荐菴違с障ゃ潟ゃ潟帥違鴻荐菴違с贋с違с臀с罩c頵i障罨<潟若箴帥 \f2@deprecated\fP ゃ潟ゃ潟帥 \f2{@link}\fP 障障 |
|
1040 .LP |
|
1041 .nf |
|
1042 \f3 |
|
1043 .fl |
|
1044 /** |
|
1045 .fl |
|
1046 * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} |
|
1047 .fl |
|
1048 */ |
|
1049 .fl |
|
1050 \fP |
|
1051 .fi |
|
1052 |
|
1053 .LP |
|
1054 .LP |
|
1055 \f3潟<潟 HTML ц菴違\fP \- 鴻 HTML 綵√ц菴違違障 HTML 潟cc若篏帥綽荀 HTML 帥違篏睡с潟障荐菴違 HTML 若吾с潟篏睡吟泣若篁紙若吾с潟篏睡с障 罔羣鴻宴若c潟違鴻帥ゃ激若 (CSS) 若鴻 (ャ<潟若激с潟潟<潟篁ュ) HTML 3.2 羣潟若篏障若祉絲上<ゃHTML 4.0荐菴違障 |
|
1056 .LP |
|
1057 .LP |
|
1058 違絨 (\f2<\fP) 潟紊с (\f2>\fP) 荐垩\f2<\fP \f2>\fP 荐菴違綽荀障罕≪潟泣潟 (\f2&\fP) \f2&\fP 荐菴違綽荀障罨<箴с若 HTML 帥 \f2<b>\fP 篏帥c障 |
|
1059 .LP |
|
1060 .LP |
|
1061 罨<ャ<潟若激с潟潟<潟腓冴障 |
|
1062 .LP |
|
1063 .nf |
|
1064 \f3 |
|
1065 .fl |
|
1066 /** |
|
1067 .fl |
|
1068 * This is a <b>doc</b> comment. |
|
1069 .fl |
|
1070 * @see java.lang.Object |
|
1071 .fl |
|
1072 */ |
|
1073 .fl |
|
1074 \fP |
|
1075 .fi |
|
1076 |
|
1077 .LP |
|
1078 .LP |
|
1079 \f3茵≪鴻帥鴻\fP \- Javadoc ャ<潟若激с潟潟<潟茹f茵≪鴻帥鴻 (\f2*\fP) 鴻贋障 障≪鴻帥鴻 (\f2*\fP) 腥榊純帥贋障若吾с 1.4 茵≪鴻帥鴻ャ腥榊醇絖ゃ障潟若箴贋・ャ<潟若激с潟潟<潟 \f2<PRE>\fP 帥医若鴻ゃ潟潟篆障絽吾吟腥榊醇絖帥筝緇茹i障ゃ潟潟阪絖 \f2/**\fP 障 \f2<PRE>\fP 帥違綏絲障 |
|
1080 .LP |
|
1081 .LP |
|
1082 \f3\fP \- ャ<潟若激с潟潟<潟絎h潟cc若≪膂≧ゅ荀膣с綽荀障翫鴻若鴻帥障壕膓 (宴若沿荐絎翫)障帥違篏臀х障Javadoc 若c HTML 若吾<潟若网荀潟若障 |
|
1083 .LP |
|
1084 .LP |
|
1085 \f3茲違c若絎h\fP \- Java с1 ゃц違c若絎hс障 1 ゃャ<潟若激с潟潟<潟荐菴違с障 潟<潟鴻c若絲障潟若障cc若ャ<潟若激с潟潟<潟荐菴違綽荀翫c若ャуh違障違罨<ャ<潟若激с潟潟<潟1 ゃ絎h荐菴違筝с 翫絎h 2 ゃс障 |
|
1086 .LP |
|
1087 .RS 3 |
|
1088 |
|
1089 .LP |
|
1090 .nf |
|
1091 \f3 |
|
1092 .fl |
|
1093 /** |
|
1094 .fl |
|
1095 * The horizontal and vertical distances of point (x,y) |
|
1096 .fl |
|
1097 */ |
|
1098 .fl |
|
1099 public int x, y; // Avoid this |
|
1100 .fl |
|
1101 \fP |
|
1102 .fi |
|
1103 .RE |
|
1104 |
|
1105 .LP |
|
1106 .LP |
|
1107 筝荐潟若罨<ャ<潟障 |
|
1108 .LP |
|
1109 .RS 3 |
|
1110 |
|
1111 .LP |
|
1112 .nf |
|
1113 \f3 |
|
1114 .fl |
|
1115 public int \fP\f3x\fP |
|
1116 .fl |
|
1117 .fi |
|
1118 |
|
1119 .LP |
|
1120 .RS 3 |
|
1121 The horizontal and vertical distances of point (x,y) |
|
1122 .RE |
|
1123 |
|
1124 .LP |
|
1125 .nf |
|
1126 \f3 |
|
1127 .fl |
|
1128 public int \fP\f3y\fP |
|
1129 .fl |
|
1130 .fi |
|
1131 |
|
1132 .LP |
|
1133 .RS 3 |
|
1134 The horizontal and vertical distances of point (x,y) |
|
1135 .RE |
|
1136 |
|
1137 .LP |
|
1138 .RE |
|
1139 .LP |
|
1140 \f3荀冴帥違鴻鋎睡\fP \- <潟若絲障ャ<潟若激с潟潟<潟荐菴違<H1> <H2> HTML 荀冴帥違鴻鋎帥с Javadoc 若絎罕ャ<潟篏с罕帥違篏帥ャ<潟綵√綵演帥障鴻宴若吾潟<潟с荀冴帥違篏帥c罕腟睡障障 |
|
1141 .LP |
|
1142 .SS |
|
1143 <純潟<潟潟 |
|
1144 .LP |
|
1145 .LP |
|
1146 Javadoc 若罨< 2 ゃ翫鴻潟ゃ潟帥с若鴻<純潟<潟潟若障膓帥罘純障潟潟鴻帥c若喝ャ絖鴻ャ<潟若激с潟潟<潟膓帥障 |
|
1147 .LP |
|
1148 .RS 3 |
|
1149 .TP 2 |
|
1150 o |
|
1151 \f3潟<潟膓帥荀ゃ鴻\fP \- 筝肢障 \f2@return\fP 帥違\f2@param\fP 帥違\f2@throws\fP 帥違<純潟<潟цゃ翫Javadoc 若若若ゃ<純障絎茖翫<純絲上筝肢障帥違潟<潟罨<≪眼冴緇c潟若障 |
|
1152 .LP |
|
1153 ウ絲劫<若帥 \f2@param\fP 帥違荀ゃ翫<若帥潟<潟筝篏膓翠絮ゃ<純潟若障劫箴紊 \f2@throws\fP 帥違荀ゃ翫箴紊絎h翫 \f2@throws\fP 帥違潟若障 |
|
1154 .LP |
|
1155 篏若吾с 1.3 篁ュ篏絲丞хс 障с若吾с潟с筝肢障帥違絖違潟<潟筝膓帥障с |
|
1156 .TP 2 |
|
1157 o |
|
1158 \f3{@inheritDoc} 帥違ゃ潟<潟腓榊膓帥\fP \- ゃ潟ゃ潟帥 \f2{@inheritDoc}\fP <純筝肢障 \f2@return\fP\f2@param\fP\f2@throws\fP 帥違潟<潟水ャ障 膓帥絲上筝肢障帥違潟<潟膊潟若障 |
|
1159 .RE |
|
1160 |
|
1161 .LP |
|
1162 .LP |
|
1163 ャ<潟若激с潟潟<潟絎潟若膓帥<純純若鴻<ゃ \-sourcepath ф絎鴻臀綽荀障潟潟茵с鴻宴若吾羝<綽荀障鴻鴻ャ<潟鴻с違c 1.3.x 篁ュ若鴻違障 |
|
1164 .LP |
|
1165 .LP |
|
1166 \f3鴻潟ゃ潟帥с若鴻膓\fP \- 鴻潟ゃ潟帥с若鴻膓帥罨< 3 ゃ翫潟<潟膓帥茵障 |
|
1167 .LP |
|
1168 .RS 3 |
|
1169 .TP 2 |
|
1170 o |
|
1171 鴻<純鴻若若鴻<純若若ゃ |
|
1172 .TP 2 |
|
1173 o |
|
1174 ゃ潟帥с若鴻<純鴻若若ゃ潟帥с若鴻<純若若ゃ |
|
1175 .TP 2 |
|
1176 o |
|
1177 鴻<純ゃ潟帥с若鴻<純絎茖 |
|
1178 .RE |
|
1179 |
|
1180 .LP |
|
1181 .LP |
|
1182 2 ゃ宴若 (<純若若ゃ翫) сJavadoc 若潟<潟膓帥若若ゃ<純ャ<潟若若ゃ絨頳冴若若ゃ<純吾潟吾莨若帥障 |
|
1183 .LP |
|
1184 .LP |
|
1185 3 ょ宴若 (劫鴻<純ゃ潟帥с若鴻<純絎茖翫) сjavadoc 若若若ゃ<純ャ<潟絎臂絨頳冴絎茖<純吾潟吾莨若帥障潟<潟膓帥障 |
|
1186 .LP |
|
1187 .LP |
|
1188 \f3<純茯膓帥≪眼冴\fP \- <純ャ<潟若激с潟潟<潟荐菴違翫障 {@inheritDoc} 帥違翫Javadoc 若罨<≪眼冴篏睡潟<潟罎膣≪障 ≪眼冴cャ<潟若激с潟潟<潟罎膣≪с荐荐鴻若若鴻ゃ潟帥с若鴻c障 |
|
1189 .LP |
|
1190 .RS 3 |
|
1191 .TP 3 |
|
1192 1. |
|
1193 贋・絎茖 (障≦宍) ゃ潟帥с若鴻<純絎h implements (障 extends) 若若糸眼綺с1 ゃよ帥鴻<純ゃ荀ゃcャ<潟若激с潟潟<潟。 |
|
1194 .TP 3 |
|
1195 2. |
|
1196 1 сャ<潟若激с潟潟<潟荀ゃc翫贋・絎茖 (障≦宍) ゃ潟帥с若鴻絲障≪眼冴篏絽亥 (綺 1 сゃ潟帥с若鴻茯帥鴻綺) |
|
1197 .TP 3 |
|
1198 3. |
|
1199 2 сャ<潟若激с潟潟<潟荀ゃc翫с鴻 Object 篁ュ鴻с (ゃ潟帥с若鴻с) 翫罨< |
|
1200 .RS 3 |
|
1201 .TP 3 |
|
1202 a. |
|
1203 鴻若若鴻<純ゃャ<潟若激с潟潟<潟荐菴違違潟<潟。 |
|
1204 .TP 3 |
|
1205 b. |
|
1206 3a сャ<潟若激с潟潟<潟荀ゃc翫鴻若若鴻絲障≪眼冴篏 |
|
1207 .RE |
|
1208 .RE |
|
1209 |
|
1210 .LP |
|
1211 .SH "javadoc 帥" |
|
1212 .LP |
|
1213 .LP |
|
1214 Javadoc 若Java ャ<潟若激с潟潟<潟莨若障劫ャ帥違茹f障ャ<潟若激с潟帥違篏帥後眼c絎 API ャ<潟純若鴻潟若с障帥違箴∴ (\f2@\fP) у障紊ф絖絨絖阪ャ障 帥違絎紊ф絖絨絖篏睡荐菴違綽荀障帥違茵 (茵腥榊純ュ純≪鴻帥鴻ゃ) 臀違障d帥違 1 障荐菴違障違\f2@see\fP 帥違茲違翫鴻 1 障荐菴違障 |
|
1215 .LP |
|
1216 .LP |
|
1217 帥違 2 ゃ帥ゃ障 |
|
1218 .LP |
|
1219 .RS 3 |
|
1220 .TP 2 |
|
1221 o |
|
1222 \f3帥\fP \- 筝肢膓帥違祉激с喝粋菴医純帥違\f2@tag\fP 綵√障 |
|
1223 .TP 2 |
|
1224 o |
|
1225 \f3ゃ潟ゃ潟帥\fP \- 潟<潟筝肢障帥違潟<潟荐菴医純ゃ潟ゃ潟帥違\f2{@tag}\fP 筝綣су蚊帥障 |
|
1226 .RE |
|
1227 |
|
1228 .LP |
|
1229 .LP |
|
1230 篁緇若鴻уャ帥違ゃ |
|
1231 .na |
|
1232 \f2Proposed Javadoc Tags\fP @ |
|
1233 .fi |
|
1234 http://java.sun.com/j2se/javadoc/proposed\-tags.htmlс |
|
1235 .LP |
|
1236 .LP |
|
1237 憝鴻ф鴻帥違罨<с |
|
1238 .LP |
|
1239 .RS 3 |
|
1240 |
|
1241 .LP |
|
1242 .LP |
|
1243 .TS |
|
1244 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
|
1245 .de 35 |
|
1246 .ps \n(.s |
|
1247 .vs \n(.vu |
|
1248 .in \n(.iu |
|
1249 .if \n(.u .fi |
|
1250 .if \n(.j .ad |
|
1251 .if \n(.j=0 .na |
|
1252 .. |
|
1253 .nf |
|
1254 .nr #~ 0 |
|
1255 .if n .nr #~ 0.6n |
|
1256 .ds #d .d |
|
1257 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
1258 .fc |
|
1259 .nr 33 \n(.s |
|
1260 .rm 80 81 |
|
1261 .nr 34 \n(.lu |
|
1262 .eo |
|
1263 .am 81 |
|
1264 .br |
|
1265 .di a+ |
|
1266 .35 |
|
1267 .ft \n(.f |
|
1268 .ll \n(34u*1u/3u |
|
1269 .if \n(.l<\n(81 .ll \n(81u |
|
1270 .in 0 |
|
1271 \f3絨ャ JDK/SDK 若吾с\fP |
|
1272 .br |
|
1273 .di |
|
1274 .nr a| \n(dn |
|
1275 .nr a- \n(dl |
|
1276 .. |
|
1277 .ec \ |
|
1278 .35 |
|
1279 .nf |
|
1280 .ll \n(34u |
|
1281 .nr 80 0 |
|
1282 .nr 38 \w\f3帥\fP |
|
1283 .if \n(80<\n(38 .nr 80 \n(38 |
|
1284 .nr 38 \w\f2@author\fP |
|
1285 .if \n(80<\n(38 .nr 80 \n(38 |
|
1286 .nr 38 \w\f2{@code}\fP |
|
1287 .if \n(80<\n(38 .nr 80 \n(38 |
|
1288 .nr 38 \w\f2{@docRoot}\fP |
|
1289 .if \n(80<\n(38 .nr 80 \n(38 |
|
1290 .nr 38 \w\f2@deprecated\fP |
|
1291 .if \n(80<\n(38 .nr 80 \n(38 |
|
1292 .nr 38 \w\f2@exception\fP |
|
1293 .if \n(80<\n(38 .nr 80 \n(38 |
|
1294 .nr 38 \w\f2{@inheritDoc}\fP |
|
1295 .if \n(80<\n(38 .nr 80 \n(38 |
|
1296 .nr 38 \w\f2{@link}\fP |
|
1297 .if \n(80<\n(38 .nr 80 \n(38 |
|
1298 .nr 38 \w\f2{@linkplain}\fP |
|
1299 .if \n(80<\n(38 .nr 80 \n(38 |
|
1300 .nr 38 \w\f2{@literal}\fP |
|
1301 .if \n(80<\n(38 .nr 80 \n(38 |
|
1302 .nr 38 \w\f2@param\fP |
|
1303 .if \n(80<\n(38 .nr 80 \n(38 |
|
1304 .nr 38 \w\f2@return\fP |
|
1305 .if \n(80<\n(38 .nr 80 \n(38 |
|
1306 .nr 38 \w\f2@see\fP |
|
1307 .if \n(80<\n(38 .nr 80 \n(38 |
|
1308 .nr 38 \w\f2@serial\fP |
|
1309 .if \n(80<\n(38 .nr 80 \n(38 |
|
1310 .nr 38 \w\f2@serialData\fP |
|
1311 .if \n(80<\n(38 .nr 80 \n(38 |
|
1312 .nr 38 \w\f2@serialField\fP |
|
1313 .if \n(80<\n(38 .nr 80 \n(38 |
|
1314 .nr 38 \w\f2@since\fP |
|
1315 .if \n(80<\n(38 .nr 80 \n(38 |
|
1316 .nr 38 \w\f2@throws\fP |
|
1317 .if \n(80<\n(38 .nr 80 \n(38 |
|
1318 .nr 38 \w\f2{@value}\fP |
|
1319 .if \n(80<\n(38 .nr 80 \n(38 |
|
1320 .nr 38 \w\f2@version\fP |
|
1321 .if \n(80<\n(38 .nr 80 \n(38 |
|
1322 .80 |
|
1323 .rm 80 |
|
1324 .nr 81 0 |
|
1325 .nr 38 \w1.0 |
|
1326 .if \n(81<\n(38 .nr 81 \n(38 |
|
1327 .nr 38 \w1.5 |
|
1328 .if \n(81<\n(38 .nr 81 \n(38 |
|
1329 .nr 38 \w1.3 |
|
1330 .if \n(81<\n(38 .nr 81 \n(38 |
|
1331 .nr 38 \w1.0 |
|
1332 .if \n(81<\n(38 .nr 81 \n(38 |
|
1333 .nr 38 \w1.0 |
|
1334 .if \n(81<\n(38 .nr 81 \n(38 |
|
1335 .nr 38 \w1.4 |
|
1336 .if \n(81<\n(38 .nr 81 \n(38 |
|
1337 .nr 38 \w1.2 |
|
1338 .if \n(81<\n(38 .nr 81 \n(38 |
|
1339 .nr 38 \w1.4 |
|
1340 .if \n(81<\n(38 .nr 81 \n(38 |
|
1341 .nr 38 \w1.5 |
|
1342 .if \n(81<\n(38 .nr 81 \n(38 |
|
1343 .nr 38 \w1.0 |
|
1344 .if \n(81<\n(38 .nr 81 \n(38 |
|
1345 .nr 38 \w1.0 |
|
1346 .if \n(81<\n(38 .nr 81 \n(38 |
|
1347 .nr 38 \w1.0 |
|
1348 .if \n(81<\n(38 .nr 81 \n(38 |
|
1349 .nr 38 \w1.2 |
|
1350 .if \n(81<\n(38 .nr 81 \n(38 |
|
1351 .nr 38 \w1.2 |
|
1352 .if \n(81<\n(38 .nr 81 \n(38 |
|
1353 .nr 38 \w1.2 |
|
1354 .if \n(81<\n(38 .nr 81 \n(38 |
|
1355 .nr 38 \w1.1 |
|
1356 .if \n(81<\n(38 .nr 81 \n(38 |
|
1357 .nr 38 \w1.2 |
|
1358 .if \n(81<\n(38 .nr 81 \n(38 |
|
1359 .nr 38 \w1.4 |
|
1360 .if \n(81<\n(38 .nr 81 \n(38 |
|
1361 .nr 38 \w1.0 |
|
1362 .if \n(81<\n(38 .nr 81 \n(38 |
|
1363 .81 |
|
1364 .rm 81 |
|
1365 .nr 38 \n(a- |
|
1366 .if \n(81<\n(38 .nr 81 \n(38 |
|
1367 .35 |
|
1368 .nf |
|
1369 .ll \n(34u |
|
1370 .nr 38 1n |
|
1371 .nr 79 0 |
|
1372 .nr 40 \n(79+(0*\n(38) |
|
1373 .nr 80 +\n(40 |
|
1374 .nr 41 \n(80+(3*\n(38) |
|
1375 .nr 81 +\n(41 |
|
1376 .nr TW \n(81 |
|
1377 .if t .if \n(TW>\n(.li .tm Table at line 1125 file Input is too wide - \n(TW units |
|
1378 .fc |
|
1379 .nr #T 0-1 |
|
1380 .nr #a 0-1 |
|
1381 .eo |
|
1382 .de T# |
|
1383 .ds #d .d |
|
1384 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
1385 .mk ## |
|
1386 .nr ## -1v |
|
1387 .ls 1 |
|
1388 .ls |
|
1389 .. |
|
1390 .ec |
|
1391 .ne \n(a|u+\n(.Vu |
|
1392 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
1393 .ta \n(80u \n(81u |
|
1394 .nr 31 \n(.f |
|
1395 .nr 35 1m |
|
1396 \&\h'|\n(40u'\f3帥\fP\h'|\n(41u' |
|
1397 .mk ## |
|
1398 .nr 31 \n(## |
|
1399 .sp |\n(##u-1v |
|
1400 .nr 37 (\n(41u+\n(81u-\n(a-u)/2u |
|
1401 .in +\n(37u |
|
1402 .a+ |
|
1403 .in -\n(37u |
|
1404 .mk 32 |
|
1405 .if \n(32>\n(31 .nr 31 \n(32 |
|
1406 .sp |\n(31u |
|
1407 .ta \n(80u \n(81u |
|
1408 .nr 31 \n(.f |
|
1409 .nr 35 1m |
|
1410 \&\h'|\n(40u'\f2@author\fP\h'|\n(41u'1.0 |
|
1411 .ta \n(80u \n(81u |
|
1412 .nr 31 \n(.f |
|
1413 .nr 35 1m |
|
1414 \&\h'|\n(40u'\f2{@code}\fP\h'|\n(41u'1.5 |
|
1415 .ta \n(80u \n(81u |
|
1416 .nr 31 \n(.f |
|
1417 .nr 35 1m |
|
1418 \&\h'|\n(40u'\f2{@docRoot}\fP\h'|\n(41u'1.3 |
|
1419 .ta \n(80u \n(81u |
|
1420 .nr 31 \n(.f |
|
1421 .nr 35 1m |
|
1422 \&\h'|\n(40u'\f2@deprecated\fP\h'|\n(41u'1.0 |
|
1423 .ta \n(80u \n(81u |
|
1424 .nr 31 \n(.f |
|
1425 .nr 35 1m |
|
1426 \&\h'|\n(40u'\f2@exception\fP\h'|\n(41u'1.0 |
|
1427 .ta \n(80u \n(81u |
|
1428 .nr 31 \n(.f |
|
1429 .nr 35 1m |
|
1430 \&\h'|\n(40u'\f2{@inheritDoc}\fP\h'|\n(41u'1.4 |
|
1431 .ta \n(80u \n(81u |
|
1432 .nr 31 \n(.f |
|
1433 .nr 35 1m |
|
1434 \&\h'|\n(40u'\f2{@link}\fP\h'|\n(41u'1.2 |
|
1435 .ta \n(80u \n(81u |
|
1436 .nr 31 \n(.f |
|
1437 .nr 35 1m |
|
1438 \&\h'|\n(40u'\f2{@linkplain}\fP\h'|\n(41u'1.4 |
|
1439 .ta \n(80u \n(81u |
|
1440 .nr 31 \n(.f |
|
1441 .nr 35 1m |
|
1442 \&\h'|\n(40u'\f2{@literal}\fP\h'|\n(41u'1.5 |
|
1443 .ta \n(80u \n(81u |
|
1444 .nr 31 \n(.f |
|
1445 .nr 35 1m |
|
1446 \&\h'|\n(40u'\f2@param\fP\h'|\n(41u'1.0 |
|
1447 .ta \n(80u \n(81u |
|
1448 .nr 31 \n(.f |
|
1449 .nr 35 1m |
|
1450 \&\h'|\n(40u'\f2@return\fP\h'|\n(41u'1.0 |
|
1451 .ta \n(80u \n(81u |
|
1452 .nr 31 \n(.f |
|
1453 .nr 35 1m |
|
1454 \&\h'|\n(40u'\f2@see\fP\h'|\n(41u'1.0 |
|
1455 .ta \n(80u \n(81u |
|
1456 .nr 31 \n(.f |
|
1457 .nr 35 1m |
|
1458 \&\h'|\n(40u'\f2@serial\fP\h'|\n(41u'1.2 |
|
1459 .ta \n(80u \n(81u |
|
1460 .nr 31 \n(.f |
|
1461 .nr 35 1m |
|
1462 \&\h'|\n(40u'\f2@serialData\fP\h'|\n(41u'1.2 |
|
1463 .ta \n(80u \n(81u |
|
1464 .nr 31 \n(.f |
|
1465 .nr 35 1m |
|
1466 \&\h'|\n(40u'\f2@serialField\fP\h'|\n(41u'1.2 |
|
1467 .ta \n(80u \n(81u |
|
1468 .nr 31 \n(.f |
|
1469 .nr 35 1m |
|
1470 \&\h'|\n(40u'\f2@since\fP\h'|\n(41u'1.1 |
|
1471 .ta \n(80u \n(81u |
|
1472 .nr 31 \n(.f |
|
1473 .nr 35 1m |
|
1474 \&\h'|\n(40u'\f2@throws\fP\h'|\n(41u'1.2 |
|
1475 .ta \n(80u \n(81u |
|
1476 .nr 31 \n(.f |
|
1477 .nr 35 1m |
|
1478 \&\h'|\n(40u'\f2{@value}\fP\h'|\n(41u'1.4 |
|
1479 .ta \n(80u \n(81u |
|
1480 .nr 31 \n(.f |
|
1481 .nr 35 1m |
|
1482 \&\h'|\n(40u'\f2@version\fP\h'|\n(41u'1.0 |
|
1483 .fc |
|
1484 .nr T. 1 |
|
1485 .T# 1 |
|
1486 .35 |
|
1487 .rm a+ |
|
1488 .TE |
|
1489 .if \n-(b.=0 .nr c. \n(.c-\n(d.-44 |
|
1490 |
|
1491 .LP |
|
1492 .RE |
|
1493 .LP |
|
1494 鴻帥帥違ゃ\-tag 激с潟с |
|
1495 .LP |
|
1496 .RS 3 |
|
1497 .TP 3 |
|
1498 @author\ name\-text |
|
1499 \-author 激с潟篏帥翫ャ<潟菴遵絎 \f2name\-text\fP 吾莨若帥障1 ゃャ<潟若激с潟潟<潟茲違 \f2@author\fP 帥違с障1 ゃ \f2@author\fP 帥違 1 ゃ絎1 ゃ帥違茲違絎с障翫Javadoc 若c潟潟 (\f2,\fP) 鴻若鴻水ャ障緇翫鴻篏茹fャ<潟障障潟若障c潟潟с荐茯絲上阪絖篏帥綽荀1 ゃ帥違茲違絎 |
|
1500 .RE |
|
1501 |
|
1502 .LP |
|
1503 .RS 3 |
|
1504 |
|
1505 .LP |
|
1506 .LP |
|
1507 荅括完ゃ帥違篏睡с贋 |
|
1508 .na |
|
1509 \f2@author 帥違ャ<潟\fP @ |
|
1510 .fi |
|
1511 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@authorс |
|
1512 .LP |
|
1513 .LP |
|
1514 |
|
1515 .LP |
|
1516 .RE |
|
1517 .RS 3 |
1500 .TP 3 |
1518 .TP 3 |
1501 @deprecated\ deprecated\-text |
1519 @deprecated\ deprecated\-text |
1502 .RS 3 |
1520 .RS 3 |
1503 |
1521 |
1504 .LP |
1522 .LP |
1505 .LP |
1523 .LP |
1506 注: JDK 5.0 から、@Deprecated 注釈を使って特定のプログラム要素を非推奨にできるようになりました。 |
1524 羈: JDK 5.0 |
1507 .LP |
|
1508 この API は (動作はするが) 使用すべきでないことを示す |
|
1509 コメントを追加します。 |
|
1510 .B javadoc |
|
1511 は、deprecated-text を説明の前に移動してイタリックにし、 |
|
1512 その前にボールドの警告 |
|
1513 「推奨されません。」を追加します。このタグはすべての doc コメント (概要、パッケージ、クラス、インタフェース、コンストラクタ、メソッド、フィールド) で有効です。 |
|
1514 .LP |
|
1515 .RS |
|
1516 deprecated-text の最初の文では、少なくともユーザにどのようなときに |
|
1517 その API が推奨されないか、およびそれに代わる API を提示する |
|
1518 必要があります。 |
|
1519 .B javadoc |
|
1520 は、最初の文だけを要約セクションと索引にコピーします。 |
|
1521 あとに続く文で、なぜその API が推奨されないかを |
|
1522 説明することもできます。代わりの API を |
|
1523 指し示す {\f3@link\f1} タグ ( |
|
1524 .B javadoc |
|
1525 1.2 以降の場合) を含める必要があります。 |
|
1526 .LP |
|
1527 詳細については、 |
|
1528 .fi |
|
1529 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@deprecated |
|
1530 の |
|
1531 .na |
1525 .na |
1532 \f2@deprecated タグのドキュメント\fPを参照してください。 |
1526 \f2@Deprecated 羈\fP @ |
1533 .LP |
1527 .fi |
1534 .TP 2 |
1528 http://java.sun.com/javase/6/docs/technotes/guides/javadoc/deprecation/deprecation.html篏帥c劫違荀膣ィ絅с障 |
1535 \(bu |
1529 .LP |
1536 .B javadoc |
1530 .RE |
1537 1.2 以降では、{\f3@link\f1} タグを使用してください。これにより、 |
1531 .RE |
1538 必要な場所にインラインで |
1532 .RS 3 |
1539 リンクが作成されます。たとえば、次のように使います。 |
1533 |
1540 .LP |
1534 .LP |
1541 .RS |
1535 .LP |
1542 .ft 3 |
1536 API 篏膓障 API 篏睡鴻с腓冴潟<潟菴遵障Javadoc 若\f2deprecated\-text\fP 筝肢腱糸ゃ帥若茘ィ絅障菴遵障帥違鴻ャ<潟若激с潟潟<潟ゃ障网荀宴若吾鴻ゃ潟帥с若鴻潟潟鴻帥<純潟c若ф鴻с |
1543 .nf |
1537 .LP |
|
1538 .LP |
|
1539 \f2deprecated\-text\fP с絨 API ィ絅c篁f推戎鴻 API 茯腓冴綽荀障Javadoc 若网荀祉激с潟膣√潟若障с API ィ絅宴茯с障障篁c API 腓冴 \f2{@link}\fP 帥 (Javadoc 1.2 篁ラ翫) 綽荀障 罨<荐菴違障 |
|
1540 .LP |
|
1541 .LP |
|
1542 荅括完ゃ |
|
1543 .na |
|
1544 \f2@deprecated 帥違ャ<潟\fP @ |
|
1545 .fi |
|
1546 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@deprecatedс |
|
1547 .LP |
|
1548 .RS 3 |
|
1549 .TP 2 |
|
1550 o |
|
1551 Javadoc 1.2 篁ラс\f2{@link}\fP 帥違篏睡障綽荀贋ゃ潟ゃ潟с潟篏с障箴腓冴障 |
|
1552 .RE |
|
1553 |
|
1554 .LP |
|
1555 .RS 3 |
|
1556 |
|
1557 .LP |
|
1558 .nf |
|
1559 \f3 |
|
1560 .fl |
1544 /** |
1561 /** |
1545 * @deprecated As of JDK 1.1, replaced by |
1562 .fl |
1546 * {@link #setBounds(int,int,int,int)} |
1563 * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} |
|
1564 .fl |
1547 */ |
1565 */ |
1548 .fi |
1566 .fl |
1549 .ft 1 |
1567 |
1550 .RE |
1568 .fl |
1551 .LP |
1569 \fP |
1552 .TP 2 |
1570 .fi |
1553 \(bu |
1571 .RE |
1554 .B javadoc |
1572 |
1555 1.1 では、各 |
1573 .LP |
1556 .B @deprecated |
1574 .RS 3 |
1557 タグに |
1575 .TP 2 |
1558 .B @see |
1576 o |
1559 タグ (インラインにできない) を作成するのが標準の形式です。 |
1577 Javadoc 1.1 с \f2@deprecated\fP 帥違絲障 \f2@see\fP 帥 (ゃ潟ゃ潟с) 荐菴違罔羣綵√с |
1560 .LP |
1578 .RE |
1561 推奨されないタグについての詳細は、「 |
1579 |
1562 .B @deprecated |
1580 .LP |
1563 タグ」 を参照してください。 |
1581 .LP |
1564 .RE |
1582 ィ絅帥違ゃ荅括完 |
1565 .TP |
1583 .na |
1566 .B {@code text} |
1584 \f2@deprecated 帥\fP @ |
1567 <code>{@literal}</code> と同等です。 |
1585 .fi |
1568 .LP |
1586 http://java.sun.com/javase/6/docs/technotes/guides/javadoc/deprecation/index.htmlャ<潟с |
1569 テキストを HTML マークアップまたは |
1587 .LP |
1570 入れ子になった javadoc タグとして解釈せずに、 |
1588 .LP |
1571 テキストをコードフォントで表示します。 |
1589 |
1572 これにより doc コメントでは、 |
1590 .LP |
1573 パラメータの種類 ( <Object> )、不等号 ( 3 < 4 )、 |
1591 .RE |
1574 または矢印 ( <- ) などで、HTML エンティティ ( < および > ) ではなく、 |
1592 .RS 3 |
1575 通常の山括弧 (< および >) を使用できます。 |
1593 .TP 3 |
1576 たとえば doc コメントのテキスト |
1594 {@code\ text} |
1577 .LP |
1595 \f2<code>{@literal}</code>\fP 膈с |
1578 .RS 5 |
1596 .RE |
1579 {@code A<B>C} |
1597 |
1580 .RE |
1598 .LP |
1581 .LP |
1599 .RS 3 |
1582 は、生成された HTML ページで、次のようにそのまま表示されます。 |
1600 |
1583 .LP |
1601 .LP |
1584 .RS 5 |
1602 .LP |
1585 A<B>C |
1603 鴻 HTML 若≪障ャ絖c javadoc 帥違茹i\f2text\fP \f2code\fP 潟ц;腓冴障 doc 潟<潟с<若帥腮蕁 (\f2<Object>\fP)筝膈 (\f23 < 4\fP)障√ (\f2<\-\fP) сHTML 潟cc (\f2<\fP \f2>\fP) с絽吾絮掩綣 (\f2<\fP \f2>\fP) 篏睡с障 doc 潟<潟鴻 |
1586 .RE |
1604 .LP |
1587 .LP |
1605 .nf |
1588 注目すべき点として、<B> は太字であると解釈されませんが、 |
1606 \f3 |
1589 コードフォントになります。 |
1607 .fl |
1590 .LP |
1608 \fP\f4{@code A<B>C}\fP\f3 |
1591 コードフォントなしで同じ機能を実現するには、 |
1609 .fl |
1592 {@literal} を使用します。 |
1610 |
1593 .RE |
1611 .fl |
1594 .TP |
1612 \fP |
1595 .B {@docRoot} |
1613 .fi |
1596 生成された任意のページを起点とした、ドキュメントの (出力先) |
1614 |
1597 ルートディレクトリの相対パスを表します。このタグは、著作権ページ |
1615 .LP |
1598 または会社のロゴなど、生成されるすべてのページから参照するファイル |
1616 .LP |
1599 を取り込むときに使います。通常は、各ページの最下部から著作権 |
1617 HTML 若吾с罨<障乗;腓冴障 |
1600 ページにリンクします。 |
1618 .LP |
1601 .RS |
1619 .nf |
1602 .LP |
1620 \f3 |
1603 この \f2{@docRoot}\fP タグは、コマンド行からも、ドキュメンテーションコメントの中でも使用できます。このタグは、@return、@param、@deprecated などの任意のタグのテキスト部分を含む、すべてのドキュメンテーションコメント、つまり概要、パッケージ、クラス、インタフェース、コンストラクタ、メソッド、およびフィールドで有効です。 |
1621 .fl |
1604 .TP 4 |
1622 \fP\f4A<B>C\fP\f3 |
|
1623 .fl |
|
1624 |
|
1625 .fl |
|
1626 \fP |
|
1627 .fi |
|
1628 |
|
1629 .LP |
|
1630 .LP |
|
1631 羈鴻鴻\f2<B>\fP 紊絖с茹i障潟若潟障 |
|
1632 .LP |
|
1633 .LP |
|
1634 潟若潟у罘純絎憗\f2{@literal}\fP 篏睡障 |
|
1635 .LP |
|
1636 .LP |
|
1637 |
|
1638 .LP |
|
1639 .RE |
|
1640 .RS 3 |
|
1641 .TP 3 |
|
1642 {@docRoot} |
|
1643 若吾荀ャ<潟 () 若c吾後障鴻茵障帥違篏罔若吾篌腓障眼鴻若吾с<ゃ腟粋昭箴水с絽吾若吾筝篏罔若吾潟障 |
|
1644 .RE |
|
1645 |
|
1646 .LP |
|
1647 .RS 3 |
|
1648 |
|
1649 .LP |
|
1650 .LP |
|
1651 \f2{@docRoot}\fP 帥違潟潟茵ャ<潟若激с潟潟<潟筝с篏睡с障帥違@return@param@deprecated 篁紙帥違鴻鴻ャ<潟若激с潟潟<潟ゃ障网荀宴若吾鴻ゃ潟帥с若鴻潟潟鴻帥<純潟c若ф鴻с |
|
1652 .LP |
|
1653 .RS 3 |
|
1654 .TP 3 |
1605 1. |
1655 1. |
1606 コマンド行では、次のようにヘッダ (header)、フッタ (footer)、 |
1656 潟潟茵с若帥若障若罨<絎臂障 |
1607 またはページの最下部 (bottom)を定義します。 |
1657 .nf |
1608 .sp 1n |
1658 \f3 |
1609 .B javadoc \-bottom '<a href="{@docRoot}/copyright.html">Copyright</a>' |
1659 .fl |
1610 .LP |
1660 javadoc \-bottom '<a href="{@docRoot}/copyright.html">Copyright</a>' |
1611 注 - Makefile の中で {\f3@docRoot\f1}をこのように利用する場合、 |
1661 .fl |
1612 一部の Makefile プログラムでは、中括弧 { } 文字をエスケープする |
1662 |
1613 必要があります。 たとえば、Inprise MAKE バージョン 5.2 を |
1663 .fl |
1614 Windows 上で実行する場合は、{{\f3@docRoot\f1}} のように、 |
1664 \fP |
1615 中括弧を二重にする必要があります。さらに、\-bottom などの |
1665 .fi |
1616 オプションに対する引数を、単一引用符ではなく、 |
1666 .LP |
1617 二重引用符で囲む必要があります。href |
1667 \- \f2{@docRoot}\fP 翫筝 Makefile 違с筝綣 { } 絖鴻宴若綽荀障違Inprise MAKE 若吾с 5.2 Windows 筝у茵翫\f2{{@docRoot}}\fP筝綣с篋綽荀障\f2\-bottom\fP 激с潟絲障綣違筝綣膃с篋綣膃у蚊綽荀障 \f2href\fP 綣違ゃ蚊綣膃ャ障 |
1618 引数の値を囲む引用符は省略します。 |
1668 .TP 3 |
1619 .TP |
|
1620 2. |
1669 2. |
1621 doc コメントには次のように記述します。 |
1670 ャ<潟若激с潟潟<潟筝с罨<篏睡障 |
1622 .sp 1n |
1671 .nf |
1623 .nf |
1672 \f3 |
1624 .ft 3 |
1673 .fl |
1625 /** |
1674 /** |
1626 * See the <a href="{@docRoot}/copyright.html">Copyright</a>. |
1675 .fl |
1627 */ |
1676 * See the <a href="{@docRoot}/copyright.html">Copyright</a>. |
1628 .ft 1 |
1677 .fl |
1629 .fi |
1678 */ |
1630 .LP |
1679 .fl |
1631 このタグが必要な理由は、生成されるドキュメントが、サブパッケージと |
1680 |
1632 同じ階層のディレクトリに格納されるためです。たとえば、次のように指定します。 |
1681 .fl |
1633 .LP |
1682 \fP |
1634 .ti +5n |
1683 .fi |
1635 .B <a href="{@docRoot}/copyright.html"> |
1684 .RE |
1636 .LP |
1685 |
1637 次のように解決されます。 |
1686 .LP |
1638 .LP |
1687 .LP |
1639 .ti +5n |
1688 帥違綽荀宴ャ<潟泣宴若吾羞宴ら絮ゆc主с罨<箴腓冴障 |
1640 \f3<a href=".\|.\|/.\|.\|/copyright.html">\f1 .\|.\|. java/lang/Object.java の場合 |
1689 .LP |
1641 .sp 1n |
1690 .nf |
1642 および |
1691 \f3 |
1643 .sp 1n |
1692 .fl |
1644 .ti +5n |
1693 <a href="{@docRoot}/copyright.html"> |
1645 \f3<a href=".\|.\|/.\|.\|/.\|.\|/copyright.html">\f1 .\|.\|. java/lang/ref/Reference.java の場合 |
1694 .fl |
1646 .RE |
1695 |
1647 .TP |
1696 .fl |
1648 .BI @exception " class-name description" |
1697 \fP |
1649 .B @exception |
1698 .fi |
1650 タグは、 |
1699 |
1651 .BR @throws |
1700 .LP |
1652 と同義です。 |
1701 .LP |
1653 .TP |
1702 罨<茹f浦障 |
1654 {\f3@inheritDoc\f1} |
1703 .LP |
1655 最も近いスーパークラスから現在の ドキュメンテーションコメントに、ドキュメントを継承します。 この機能により、コメントは継承ツリーの上位に移動し、開発者はコピーしたテキストに記述を追加することができます。 |
1704 .nf |
1656 .LP |
1705 \f3 |
1657 このタグは、ドキュメンテーションコメントの次の位置でのみ有効です。 |
1706 .fl |
1658 .RS 3 |
1707 <a href="../../copyright.html"> java/lang/Object.java 翫 |
1659 .TP 2 |
1708 .fl |
1660 o |
1709 |
1661 メソッドの主説明ブロック内。この場合、主説明は、上位階層のクラスまたはインタフェースからコピーされる |
1710 .fl |
1662 .TP 2 |
1711 \fP |
1663 o |
1712 .fi |
1664 メソッドの @return、@param、@throws タグのテキスト引数内。この場合、タグテキストは、上位階層の対応するタグからコピーされる |
1713 |
1665 .RE |
1714 .LP |
1666 .LP |
1715 .LP |
1667 継承階層でコメントを見つける方法に関する正確な説明について、「メソッドコメントの自動コピー」を参照してください。このタグが見つからない場合、コメントは、この節で説明するルールに応じて、自動的に継承されるかどうかが決まります。 |
1716 |
1668 .LP |
1717 .LP |
1669 .TP 3 |
1718 .nf |
1670 {@link\ package.class#member\ label} |
1719 \f3 |
1671 表示テキスト label とのインラインリンクを挿入します。\f2label\fP は、参照クラスの指定されたパッケージ、クラス、またはメンバの名前のドキュメンテーションを指し示します。このタグは、@return、@param、@deprecated などの任意のタグのテキスト部分を含む、すべてのドキュメンテーションコメント、つまり概要、パッケージ、クラス、インタフェース、コンストラクタ、メソッド、およびフィールドで有効です。 |
1720 .fl |
1672 .LP |
1721 <a href="../../../copyright.html"> java/lang/ref/Reference.java 翫 |
1673 このタグは、 |
1722 .fl |
1674 .B @see |
1723 |
1675 タグとよく似ています。どちらのタグも、package.class#member および |
1724 .fl |
1676 .BI label |
1725 \fP |
1677 の参照の仕方が同じで、有効な構文もまったく同じです。 |
1726 .fi |
1678 大きな違いは、{\f3@link\f1} は、リンクを [関連項目] セクションに |
1727 |
1679 置くのではなく、インラインリンクを生成するということです。 |
1728 .LP |
1680 また、インラインテキストのほかの部分と区別するために、 |
1729 .LP |
1681 {\f3@link\f1} タグの最初と最後に中括弧を記述します。 |
1730 |
1682 ラベルの中で「}」を使う必要がある場合は、HTML |
1731 .LP |
1683 エンティティの「}」を使います。 |
1732 .RE |
1684 .LP |
1733 .RS 3 |
1685 1 つの文の中で使用できる {@link} タグの数に制限はありません。 |
1734 .TP 3 |
1686 このタグは、ドキュメンテーションコメントの説明部分、または |
1735 @exception\ class\-name\ description |
1687 .BR @deprecated |
1736 \f2@exception\fP 帥違\f2@throws\fP 帥違臂с |
1688 、 |
1737 .RE |
1689 .BR @return |
1738 |
1690 、 |
1739 .LP |
1691 .BR @param |
1740 .RS 3 |
1692 などの任意のタグのテキスト部分で使うことができます。 |
1741 |
1693 .LP |
1742 .LP |
1694 たとえば、次のコメントでは、 |
1743 .LP |
1695 .B getComponentAt(int, int) |
1744 |
1696 メソッドを参照しています。 |
1745 .LP |
1697 .LP |
1746 .RE |
1698 .ft 3 |
1747 .RS 3 |
1699 .nf |
1748 .TP 3 |
1700 Use the {\f3@link #getComponentAt(int, int) getComponentAt\f1} method. |
1749 {@inheritDoc}\ |
1701 .fi |
1750 c菴膓水純鴻障絎茖純ゃ潟帥с若鴻帥違憜ャ<潟若激с潟潟<潟ャ<潟膓 (潟) 障罘純羆潟<潟膓帥若筝篏荐菴違潟若鴻篏帥c荐菴違с障 |
1702 .ft 1 |
1751 .RE |
1703 .LP |
1752 |
1704 標準ドックレットでは、上記のコメントから次の HTML が |
1753 .LP |
1705 生成されます (このコメントが同じパッケージの別のクラスを参照している場合)。 |
1754 .RS 3 |
1706 .LP |
1755 |
1707 .ft 3 |
1756 .LP |
1708 .nf |
1757 .LP |
1709 Use the |
1758 帥違ャ<潟若激с潟潟<潟罨<篏臀с炊鴻с |
1710 <a href="Component.html#getComponentAt(int, int)">getComponentAt</a>method. |
1759 .LP |
1711 .fi |
1760 .RS 3 |
1712 .ft 1 |
1761 .TP 2 |
1713 .LP |
1762 o |
1714 この HTML は、Web ページ上では次のように表示されます。 |
1763 <純筝肢翫筝肢筝篏絮ゃ鴻障ゃ潟帥с若鴻潟若 |
1715 .LP |
1764 .TP 2 |
1716 .ft 3 |
1765 o |
1717 .nf |
1766 <純 @return@param@throws 帥違鴻綣医翫帥違鴻筝篏絮ゃ絲上帥違潟若 |
1718 Use the getComponentAt method. |
1767 .RE |
1719 .fi |
1768 |
1720 .ft 1 |
1769 .LP |
1721 .LP |
1770 .LP |
1722 {\f3@link\f1} を、ドキュメント化の対象にしていないクラスにまで |
1771 膓翠絮ゃс潟<潟荀ゃ号≪罩g∈茯ゃ<純潟<潟潟若с帥違荀ゃ翫潟<潟膀ц若綽膓帥羆冴障障 |
1723 拡張するには、 |
1772 .LP |
1724 .BR \-link |
1773 .LP |
1725 オプションを使用します。 |
1774 |
1726 .LP |
1775 .LP |
1727 詳細については、 |
1776 .RE |
1728 .fi |
1777 .RS 3 |
1729 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#{@link} |
1778 .TP 3 |
1730 の |
1779 {@link\ \ package.class#member\ \ label}\ |
|
1780 茵腓冴鴻 \f2label\fP ゃ潟ゃ潟潟水ャ障 \f2label\fP с鴻絎宴若吾鴻障<潟若ャ<潟若激с潟腓冴障帥違@return@param@deprecated 篁紙帥違鴻鴻ャ<潟若激с潟潟<潟ゃ障网荀宴若吾鴻ゃ潟帥с若鴻潟潟鴻帥<純潟c若ф鴻с |
|
1781 .RE |
|
1782 |
|
1783 .LP |
|
1784 .RS 3 |
|
1785 |
|
1786 .LP |
|
1787 .LP |
|
1788 帥違\f2@see\fP 帥違鋍若障 <帥違\f2package.class\fP\f2#\fP\f2member\fP \f2label\fP с篁鴻с鴻罕障cс紊с\f2{@link}\fP 潟 [∫i] 祉激с潟臀сゃ潟ゃ潟潟с障ゃ潟ゃ潟鴻祉阪ャ\f2{@link}\fP 帥違緇筝綣с荐菴違障筝с}篏帥綽荀翫HTML 潟cc若}篏帥障 |
|
1789 .LP |
|
1790 .LP |
|
1791 1 ゃ筝т戎с \f2{@link}\fP 帥違違狗障帥違ャ<潟若激с潟潟<潟筝肢障 @deprecated@return@param 篁紙帥違鴻т戎с障 |
|
1792 .LP |
|
1793 .LP |
|
1794 違罨<潟<潟с \f2getComponentAt(int, int)\fP <純с障 |
|
1795 .LP |
|
1796 .nf |
|
1797 \f3 |
|
1798 .fl |
|
1799 {@link #getComponentAt(int, int) getComponentAt} <純篏睡障 |
|
1800 .fl |
|
1801 |
|
1802 .fl |
|
1803 \fP |
|
1804 .fi |
|
1805 |
|
1806 .LP |
|
1807 .LP |
|
1808 罔羣с筝荐潟<潟罨< HTML 障 (潟<潟宴若吾ャ鴻с翫) |
|
1809 .LP |
|
1810 .nf |
|
1811 \f3 |
|
1812 .fl |
|
1813 <a href="Component.html#getComponentAt(int, int)">getComponentAt</a> <純篏睡障 |
|
1814 .fl |
|
1815 |
|
1816 .fl |
|
1817 \fP |
|
1818 .fi |
|
1819 |
|
1820 .LP |
|
1821 .LP |
|
1822 HTML Web 若娯с罨<茵腓冴障 |
|
1823 .LP |
|
1824 .nf |
|
1825 \f3 |
|
1826 .fl |
|
1827 getComponentAt <純篏睡障 |
|
1828 .fl |
|
1829 |
|
1830 .fl |
|
1831 \fP |
|
1832 .fi |
|
1833 |
|
1834 .LP |
|
1835 .LP |
|
1836 \f2{@link}\fP ャ<潟絲乗院鴻障ф≦宍\f2\-link\fP 激с潟篏睡障 |
|
1837 .LP |
|
1838 .LP |
|
1839 荅括完ゃ |
1731 .na |
1840 .na |
1732 \f2{@link} タグのドキュメント\fPを参照してください。 |
1841 \f2{@link} 帥違ャ<潟\fP @ |
1733 .RE |
1842 .fi |
1734 .TP |
1843 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#{@link}с |
1735 {@linkplain package.class#member label} |
1844 .LP |
1736 リンクのラベルがコードフォントではなくプレーンテキストで |
1845 .LP |
1737 表示されている点以外は、 |
1846 |
1738 {\f3@link\f1} と同じです。 ラベルがプレーンテキストで |
1847 .LP |
1739 記述されている場合に便利です。次の例を参照してください。 |
1848 .RE |
1740 .LP |
1849 .RS 3 |
1741 .ft 3 |
1850 .TP 3 |
1742 .nf |
1851 {@linkplain\ package.class#member\ label} |
1743 Refer to {\f3@linkplain\f1 add() the overridden method}. |
1852 潟潟若潟с若潟鴻ц;腓冴剛札紊 \f2{@link}\fP с若潟鴻ц菴違箴水с箴: |
1744 .fi |
1853 .RE |
1745 .ft 1 |
1854 |
1746 .LP |
1855 .LP |
1747 これは以下のように表示されます。 |
1856 .RS 3 |
1748 .LP |
1857 |
1749 .ft 3 |
1858 .LP |
1750 .nf |
1859 .nf |
1751 Refer to the overridden method. |
1860 \f3 |
1752 .fi |
1861 .fl |
1753 .ft 1 |
1862 {@linkplain add() the overridden method} с |
1754 .LP |
1863 .fl |
1755 .TP |
1864 |
1756 .B {@literal text} |
1865 .fl |
1757 テキストを HTML マークアップまたは |
1866 \fP |
1758 入れ子になった javadoc タグとして解釈せずに、 |
1867 .fi |
1759 テキストをコードフォントで表示します。 |
1868 |
1760 これにより doc コメントでは、 |
1869 .LP |
1761 パラメータの種類 ( <Object> )、不等号 ( 3 < 4 )、 |
1870 .LP |
1762 または矢印 ( <- ) などで、HTML エンティティ ( < および > ) ではなく、 |
1871 篁ヤ茵腓冴障 |
1763 通常の山括弧 (< および >) を使用できます。 |
1872 .LP |
1764 たとえば doc コメントのテキスト |
1873 .RS 3 |
1765 .LP |
1874 |
1766 .RS 5 |
1875 .LP |
1767 {@literal A<B>C} |
1876 .LP |
1768 .RE |
1877 the overridden method с |
1769 .LP |
1878 .LP |
1770 は、生成された HTML ページはブラウザで次のようにそのまま表示されます。 |
1879 .RE |
1771 .LP |
1880 .LP |
1772 .RS 5 |
1881 |
1773 A<B>C |
1882 .LP |
1774 .RE |
1883 .RE |
1775 .LP |
1884 .RS 3 |
1776 注目すべき点として、<B> は太字であると解釈され、 |
1885 .TP 3 |
1777 コードフォントになりません。 |
1886 {@literal\ text} |
1778 .LP |
1887 鴻 HTML 若≪障ャ絖c javadoc 帥違茹i\f2text\fP 茵腓冴障 doc 潟<潟с<若帥腮蕁 (\f2<Object>\fP)筝膈 (\f23 < 4\fP)障√ (\f2<\-\fP) сHTML 潟cc (\f2<\fP \f2>\fP) с絽吾絮掩綣 (\f2<\fP \f2>\fP) 篏睡с障 doc 潟<潟鴻 |
1779 コードフォントで同じ機能を実現するには、 |
1888 .RE |
1780 {@code} を使用します。 |
1889 |
1781 .TP |
1890 .LP |
1782 .BI @param " parameter-name description" |
1891 .RS 3 |
1783 指定した parameter-name と指定した description を使用して |
1892 |
1784 パラメータを「Parameters」セクションに追加します。 |
1893 .LP |
1785 doc コメントを記述するときは、description を複数行に |
1894 .nf |
1786 続けることができます。このタグは、 |
1895 \f3 |
1787 メソッド、コンストラクタ、またはクラスの |
1896 .fl |
1788 doc コメント内でのみ有効です。 |
1897 \fP\f4{@literal A<B>C}\fP\f3 |
1789 .LP |
1898 .fl |
1790 \f2parameter\-name\fP は、メソッドまたはコンストラクタでのパラメータの名前か、クラス、メソッドまたはコンストラクタのタイプパラメータの名前になります。 |
1899 |
1791 山括弧でパラメータ名を囲むと、型パラメータを使用することを |
1900 .fl |
1792 指定します。 |
1901 \fP |
1793 .LP |
1902 .fi |
1794 クラスの型パラメータの例: |
1903 |
|
1904 .LP |
|
1905 .LP |
|
1906 HTML 若吾吟ф<障乗;腓冴障 |
|
1907 .LP |
|
1908 .LP |
|
1909 \f2\ \ \ \ \ \fPA<B>C |
|
1910 .LP |
|
1911 .LP |
|
1912 羈鴻鴻\f2<B>\fP 紊絖с茹i障 (潟若潟) |
|
1913 .LP |
|
1914 .LP |
|
1915 潟若潟у罘純絎憗\f2{@code}\fP 篏睡障 |
|
1916 .LP |
|
1917 .LP |
|
1918 |
|
1919 .LP |
|
1920 .RE |
|
1921 .RS 3 |
|
1922 .TP 3 |
|
1923 @param\ parameter\-name description |
|
1924 絎 \f2parameter\-name\fP 絎 \f2description\fP 篏睡<若帥Parameters祉激с潟菴遵障doc 潟<潟荐菴違\f2description\fP 茲域膓с障帥違<純潟潟鴻帥障鴻 doc 潟<潟с炊鴻с |
|
1925 .RE |
|
1926 |
|
1927 .LP |
|
1928 .RS 3 |
|
1929 |
|
1930 .LP |
|
1931 .LP |
|
1932 \f2parameter\-name\fP <純障潟潟鴻帥с<若帥鴻<純障潟潟鴻帥帥ゃ<若帥障絮掩綣сс<若水蚊<若帥篏睡絎障 |
|
1933 .LP |
|
1934 .LP |
|
1935 鴻<若帥箴: |
|
1936 .LP |
1795 .nf |
1937 .nf |
1796 \f3 |
1938 \f3 |
1797 .fl |
1939 .fl |
1798 /** |
1940 /** |
1799 .fl |
1941 .fl |
1826 .fl |
1973 .fl |
1827 <T, V extends T> V convert(String string, Class<T> type) { |
1974 <T, V extends T> V convert(String string, Class<T> type) { |
1828 .fl |
1975 .fl |
1829 } |
1976 } |
1830 .fl |
1977 .fl |
1831 \fP |
1978 |
1832 .fi |
1979 .fl |
1833 詳細については、 |
1980 \fP |
1834 .fi |
1981 .fi |
1835 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@param |
1982 |
1836 の |
1983 .LP |
|
1984 .LP |
|
1985 荅括完ゃ |
1837 .na |
1986 .na |
1838 \f2@param タグのドキュメント\fPを参照してください。 |
1987 \f2@param 帥違ャ<潟\fP @ |
1839 .LP |
1988 .fi |
|
1989 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@paramс |
|
1990 .LP |
|
1991 .LP |
|
1992 |
|
1993 .LP |
|
1994 .RE |
|
1995 .RS 3 |
1840 .TP 3 |
1996 .TP 3 |
1841 @return\ description |
1997 @return\ description |
1842 「戻り値」セクションを追加して、\f2description\fP のテキストを書き込みます。このテキストでは、戻り値の型と、取り得る値の範囲について記述する必要があります。このタグは、メソッドのドキュメンテーションコメントでのみ有効です。 |
1998 [祉] 祉激с潟菴遵\f2description\fP 鴻吾莨若帥障鴻с祉ゃ緇ゃ膀蚊ゃ荐菴違綽荀障帥違<純ャ<潟若激с潟潟<潟с炊鴻с |
1843 .LP |
1999 .RE |
1844 詳細については、 |
2000 |
1845 .fi |
2001 .LP |
1846 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@return |
2002 .RS 3 |
1847 の |
2003 |
|
2004 .LP |
|
2005 .LP |
|
2006 荅括完ゃ |
1848 .na |
2007 .na |
1849 \f2@return タグのドキュメント\fPを参照してください。 |
2008 \f2@return 帥違ャ<潟\fP @ |
1850 .LP |
2009 .fi |
1851 .TP 3 |
2010 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@returnс |
1852 @see\ reference |
2011 .LP |
1853 「関連項目」見出しを追加し、\f2reference\fP を指すリンクか、またはテキストエントリを書き込みます。1 つのドキュメンテーションコメントには、任意の数の \f2@see\fP タグを指定できます。すべての \f2@see\fP タグの内容は、同じ見出しの下にグループ化されます。\f2@see\fP タグには、次の 3 種類の形式があります。もっともよく使われるのは、3 番目の形式です。このタグは、すべてのドキュメンテーションコメント、つまり概要、パッケージ、クラス、インタフェース、コンストラクタ、メソッド、およびフィールドで有効です。パッケージ、クラス、またはメンバに対するインラインリンクを文中に挿入する方法は、\f2{@link}\fP を参照してください。 |
2012 .LP |
|
2013 |
|
2014 .LP |
|
2015 .RE |
|
2016 .RS 3 |
|
2017 .TP 3 |
|
2018 @see\ \ reference |
|
2019 [∫i] 荀冴菴遵\f2reference\fP 潟障鴻潟吾莨若帥障1 ゃャ<潟若激с潟潟<潟篁紙違 \f2@see\fP 帥違絎с障 鴻 \f2@see\fP 帥違絎鴻荀冴筝違若障\f2@see\fP 帥違罨< 3 腮蕁綵√障 c鋎帥3 綵√с帥違鴻ャ<潟若激с潟潟<潟ゃ障网荀宴若吾鴻ゃ潟帥с若鴻潟潟鴻帥<純潟c若ф鴻с宴若吾鴻障<潟若絲障ゃ潟ゃ潟潟筝水ャ号\f2{@link}\fP с |
1854 .RS 3 |
2020 .RS 3 |
1855 .TP 3 |
2021 .TP 3 |
1856 @see "string" |
2022 @see "string" |
1857 string のテキストエントリを追加します。 |
2023 \f2string\fP 鴻潟菴遵障潟障\f2string\fP 悟障 URL с≪祉鴻с宴усJavadoc 若絖篋綣膃 (\f2"\fP) 茯帥鴻綵√祉 2 ゃ綵√阪ャ障箴腓冴障 |
1858 リンクは生成されません。string は、書籍、または |
2024 .nf |
1859 URL ではアクセスできない情報の参照先です。 |
2025 \f3 |
1860 .B javadoc |
2026 .fl |
1861 ツールは、最初の文字が二重引用符 (") かどうかを調べて、 |
|
1862 上の 2 つの形式とこの形式とを区 |
|
1863 別します。次に例を示します。 |
|
1864 .LP |
|
1865 .RS |
|
1866 .ft 3 |
|
1867 .nf |
|
1868 @see "The Java Programming Language" |
2027 @see "The Java Programming Language" |
1869 .fi |
2028 .fl |
1870 .ft 1 |
2029 |
1871 .LP |
2030 .fl |
1872 これは次のようなテキストを生成します。 |
2031 \fP |
1873 .LP |
2032 .fi |
1874 .ft 3 |
2033 .LP |
1875 .nf |
2034 罨<鴻障 |
1876 関連項目: |
2035 .RE |
1877 "The Java Programming Language" |
2036 .RS 3 |
1878 .fi |
2037 .RS 3 |
1879 .ft 1 |
2038 |
1880 .RE |
2039 .LP |
1881 .TP |
2040 .RS 3 |
1882 \f3@see <a href="\f2URL#value\f3">\f2label\f3</a>\f1 |
2041 .TP 3 |
1883 .IR URL#value |
2042 ∫i: |
1884 で定義されたとおりにリンクを追加します。 |
2043 The Java Programming Language |
1885 .I URL#value |
2044 .RE |
1886 は、相対 URL または絶対 URL です。 |
2045 |
1887 .B javadoc |
2046 .LP |
1888 ツールは、最初の文字として、小なり括弧 (\f3<\f1) を探すことで、 |
2047 .RE |
1889 このリンクをその他の場合と区別します。 |
2048 .RE |
1890 .LP |
2049 .TP 3 |
1891 .RS |
2050 @see <a href="URL#value">label</a> |
1892 .ft 3 |
2051 \f2URL\fP#\f2value\fP у臂潟菴遵障\f2URL\fP#\f2value\fP 後 URL 障腟九 URL сJavadoc 若絖絨荐 (\f2<\fP) 茯帥鴻綵√祉 2 ゃ綵√阪ャ障箴腓冴障 |
1893 .nf |
2052 .nf |
|
2053 \f3 |
|
2054 .fl |
1894 @see <a href="spec.html#section">Java Spec</a> |
2055 @see <a href="spec.html#section">Java Spec</a> |
1895 .fi |
2056 .fl |
1896 .ft 1 |
2057 |
1897 .LP |
2058 .fl |
1898 これは次のようなリンクを生成します。 |
2059 \fP |
1899 .LP |
2060 .fi |
1900 .ft 3 |
2061 .LP |
1901 .nf |
2062 罨<潟障 |
1902 関連項目: |
2063 .RS 3 |
1903 Java Spec |
2064 .RS 3 |
1904 .fi |
2065 .TP 3 |
1905 .ft 1 |
2066 ∫i: |
1906 .RE |
2067 Java Spec |
1907 .TP |
2068 .RE |
1908 .BI @see " package.class#member label" |
2069 .RE |
1909 参照される Java 言語で指定された名前のドキュメントを指す、 |
2070 .RE |
1910 表示テキスト label を持つ |
2071 .RS 3 |
1911 リンクを追加します。label は省略可能です。label を省略した場合は、 |
2072 |
1912 該当する名前が |
2073 .LP |
1913 適切に短くされて (「名前の表示方法」を参照)、 |
2074 .LP |
1914 表示テキストとして代わりに表示されます。-noqualifier を使用すると、表示テキストからパッケージ名が全体的に削除されます。ラベルは、自動生成される表示テキストとは異なる表示テキストを指定する場合に使います。 |
2075 |
1915 .LP |
2076 .LP |
1916 .RS |
2077 .RE |
1917 バージョン 1.2 では、ラベルではなく、名前だけが |
2078 .RS 3 |
1918 HTML タグ |
2079 .TP 3 |
1919 .B <code> |
2080 @see\ package.class#member\ label |
1920 に囲まれて自動的に表示されます。バージョン 1.2.2 以降は、 |
2081 絎ゃс Java 荐茯<潟若ゃャ<潟潟茵腓冴鴻 \f2label\fP 菴遵障\f2label\fP ュ純с \f2label\fP ャ潟<潟若膰茵腓冴障 茵腓冴号с\-noqualifier 篏睡茵腓冴鴻宴若後篏ゃ障茵腓冴鴻違茵腓冴鴻絎翫篏帥障 |
1921 .B <code> |
2082 .LP |
1922 は常に、ラベルが使用されているかどうかにかかわらず、 |
2083 若吾с 1.2 с <code> HTML 帥医茵腓冴障 1.2.2 篏睡<code> 絽吾茵腓冴鴻蚊<с障障 |
1923 表示可能なテキストを囲みます。 |
2084 .LP |
1924 .TP 2 |
2085 .RS 3 |
1925 \(bu |
2086 .TP 2 |
1926 .I package.class#member |
2087 o |
1927 には、Java 言語で有効な任意の名前、つまりパッケージ、 |
2088 \f4package.class\fP\f4#\fP\f4member\fP с篁紙鴻違荀膣絎障 ゃ障宴若吾鴻ゃ潟帥с若鴻潟潟鴻帥<純障c若с <潟弱若激c若荐 (\f2#\fP) х舟障\f2class\fP 篁紙障ャ絖鴻障ゃ潟帥с若鴻茵障\f2member\fP 篁紙潟潟鴻帥<純障c若 (ャ絖鴻障ゃ潟帥с若鴻с) 茵障絎ャ<潟鴻障翫Javadoc 若吾潟篏障紊с鴻吾潟篏\f2\-link\fP 激с潟篏帥障с鴻絮ャ<潟с祉 2 ゃ綵√ \f2@see\fP 帥違篏帥障綣違ゃ絎ц潟顄障 |
1928 クラス、インタフェース、 |
2089 .TP 2 |
1929 コンストラクタ、メソッド、またはフィールドの名前を指定します |
2090 o |
1930 。ただし、メンバ名の前の |
2091 \f4label\fP ュ純鴻с潟茵腓冴障\f2label\fP 腥榊純с障\f2label\fP ャ\f2package.class.member\fP 憜鴻潟宴若吾綽膰茵腓冴障 茵腓冴号с |
1931 ドットは、ハッシュ文字 (#) で置き換えます。 |
2092 .TP 2 |
1932 指定した名前が、ドキュメント化されるクラス |
2093 o |
1933 にある場合、 |
2094 腥榊醇絖\f2package.class\fP\f2#\fP\f2member\fP \f2label\fP 阪絖с綣с眼腥榊醇絖茹i<純<若翠腥榊醇絖ャ障障 |
1934 .B javadoc |
2095 .RE |
1935 ツールは該当する名前へのリンクを自動的に作成します。 |
2096 .LP |
1936 外部参照クラスへのリンクを作成する |
2097 \f3箴\fP \- 箴с\f2Character\fP 鴻 \f2@see\fP 帥違\f2String\fP 鴻 \f2equals\fP <純с障帥違 \f2String#equals(Object)\fP \f2equals\fP 筝≧鴻綣違障障 |
1937 には、 |
2098 .RS 3 |
1938 .B \-link |
2099 |
1939 オプションを使います。参照されるクラスに属していない名前の |
2100 .LP |
1940 ドキュメントを参 |
2101 .nf |
1941 照するには、ほかの 2 つの形式の |
2102 \f3 |
1942 .B @see |
2103 .fl |
1943 タグを使います。1 番目の引数については、「名前の指定」 で |
2104 /** |
1944 詳しく説明します。 |
2105 .fl |
1945 .TP 2 |
2106 * @see String#equals(Object) equals |
1946 \(bu |
2107 .fl |
1947 .I label |
2108 */ |
1948 は省略可能なテキストで、 |
2109 .fl |
1949 リンクのラベルとして表示されます。label には空白を含 |
2110 |
1950 めることができます。label を省略した場合は、 |
2111 .fl |
1951 .I package.class.member |
2112 \fP |
1952 が、現在のクラスおよびパッケージに応じて |
2113 .fi |
1953 適切に短くされて表示されます。「名前の表示方法」を参照してください。 |
2114 .RE |
1954 .TP 2 |
2115 .LP |
1955 \(bu |
2116 罔羣罨< HTML 障 |
1956 空白文字は |
2117 .RS 3 |
1957 .I package.class#member |
2118 |
1958 と |
2119 .LP |
1959 .IR label |
2120 .nf |
1960 の間の区切り文字です。括弧内の空白文字は、 |
2121 \f3 |
1961 ラベルの開始を意味しないため、 |
2122 .fl |
1962 メソッドのパラメータ間のデリミタとして使うことができます。 |
2123 <dl> |
1963 .LP |
2124 .fl |
1964 例-この例では、Character クラスの |
2125 <dt><b>See also:</b> |
1965 .B @see |
2126 .fl |
1966 タグが String クラスの equals メソッドを参照しています。 |
2127 <dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals<code></a> |
1967 タグには、名前 \f3String#equals(Object)\f1 とラベル \f3equals\f1 の |
2128 .fl |
1968 両方の引数が含まれています。 |
2129 </dl> |
1969 .LP |
2130 .fl |
1970 .ft 3 |
2131 |
1971 .nf |
2132 .fl |
1972 /** |
2133 \fP |
1973 * @see String#equals(Object) equals |
2134 .fi |
1974 */ |
2135 .RE |
1975 .fi |
2136 .LP |
1976 .ft 1 |
2137 吟с罨<茵腓冴潟鴻障 |
1977 .LP |
2138 .RS 3 |
1978 標準ドックレットは、次のような HTML を生成します。 |
2139 .RS 3 |
1979 .LP |
2140 .TP 3 |
1980 .ft 3 |
2141 ∫i: |
1981 .nf |
2142 equals |
1982 <dl> |
2143 .RE |
1983 <dt><b>関連項目:</b> |
2144 .RE |
1984 <dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals</code></a> |
2145 .RE |
1985 </dl> |
2146 |
1986 .fi |
2147 .LP |
1987 .ft 1 |
2148 .RS 3 |
1988 .LP |
2149 |
1989 これは、ブラウザでは次のように表示され、 |
2150 .LP |
1990 ラベルがリンクテキストになります。 |
2151 .LP |
1991 .LP |
2152 |
1992 .ft 3 |
2153 .LP |
1993 .nf |
2154 .LP |
1994 関連項目: |
2155 \f3絎\fP \- 帥違絎 \f2package.class\fP\f2#\fP\f2member\fP \f2java.lang.String#toUpperCase()\fP 絎絎\f2String#toUpperCase()\fP \f2#toUpperCase()\fP 絎с障絎絎翫Javadoc 若Java 潟潟ゃ絽吾罎膣∫綺с罎膣≪障荅括完@see 罎膣∫綺с<純茲違綣違綣с眼с亥榊純с障 |
1995 equals |
2156 .LP |
1996 .fi |
2157 .LP |
1997 .ft 1 |
2158 絎絎鴻ュ絖違羝純若鴻潟若茯帥с罨<茵障障綵√腓冴障 茵筝с\f2Class\fP 鴻障ゃ潟帥с若鴻\f2Type\fP 鴻ゃ潟帥с若鴻障堺若水 \f2method\fP <純障潟潟鴻帥絎с障 |
1998 .LP |
2159 .LP |
1999 .B 名前の指定: |
2160 .LP |
2000 この |
2161 |
2001 .I package.class#member |
2162 .LP |
2002 の名前は、 |
2163 .RE |
2003 .BR java.lang.String#toUpperCase() |
2164 .RS 3 |
2004 のように完全指定することも、 |
2165 .RS 3 |
2005 .B String#toUpperCase() |
|
2006 や |
|
2007 .BR #toUpperCase() |
|
2008 などのように完全指定しないことも可能です。 |
|
2009 完全指定しない場合、 |
|
2010 .B javadoc |
|
2011 ツールは、通常の Java コンパイラの検索順序で検索を行います。 |
|
2012 詳細は、以下の「 |
|
2013 .BR @see |
|
2014 の検索順序」を参照してください。指定する名前では、 |
|
2015 メソッドの複数の引数の型の間など、 |
|
2016 括弧内に空白を含めることができます。 |
|
2017 .LP |
|
2018 短い部分修飾名を指定することの利点は、入力する |
|
2019 文字数が減ることと、ソースコードが |
|
2020 読みやすくなることです。以下の表に示すのは、さまざまな |
|
2021 形式の名前です。Class には |
|
2022 クラスかインタフェース、Type にはクラス、インタフェース、 |
|
2023 配列、または基本データ型、 |
|
2024 method にはメソッドまたはコンストラクタを指定できます。 |
|
2025 .LP |
|
2026 .LP |
2166 .LP |
2027 .TS |
2167 .TS |
2028 box; |
2168 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2029 lp-1. |
2169 .de 35 |
2030 @see package.class#member の一般的な形式 |
2170 .ps \n(.s |
2031 _ |
2171 .vs \n(.vu |
2032 現在のクラスのメンバを参照する |
2172 .in \n(.iu |
2033 @see #field |
2173 .if \n(.u .fi |
2034 @see #method(Type, Type,...) |
2174 .if \n(.j .ad |
2035 @see #method(Type argname, Type argname,...) |
2175 .if \n(.j=0 .na |
2036 @see #constructor(Type, Type,...) |
2176 .. |
2037 @see #constructor(Type argname, Type argname,...) |
2177 .nf |
2038 _ |
2178 .nr #~ 0 |
2039 T{ |
2179 .if n .nr #~ 0.6n |
2040 現在の、またはインポートされたパッケージの別のクラスを参照する |
2180 .ds #d .d |
2041 T} |
2181 .if \(ts\n(.z\(ts\(ts .ds #d nl |
2042 @see Class#field |
2182 .fc |
2043 @see Class#method(Type, Type,...) |
2183 .nr 33 \n(.s |
2044 @see Class#method(Type argname, Type argname,...) |
2184 .rm 80 |
2045 @see Class#constructor(Type, Type,...) |
2185 .nr 34 \n(.lu |
2046 T{ |
2186 .eo |
2047 @see Class#constructor(Type argname, Type argname,...) |
2187 .am 80 |
2048 T} |
2188 .br |
2049 @see Class.NestedClass |
2189 .di a+ |
2050 @see Class |
2190 .35 |
2051 _ |
2191 .ft \n(.f |
2052 別のパッケージの要素を参照する (完全修飾) |
2192 .ll \n(34u*1u/2u |
2053 @see package.Class#field |
2193 .if \n(.l<\n(80 .ll \n(80u |
2054 @see package.Class#method(Type, Type,...) |
2194 .in 0 |
2055 @see package.Class#method(Type argname, Type argname,...) |
2195 \f4@see\fP\f3\ \fP\f4package.class#member\fP\f3 筝綵√\fP |
2056 @see package.Class#constructor(Type, Type,...) |
2196 .br |
2057 T{ |
2197 .di |
2058 @see package.Class#constructor(Type argname, Type argname,...) |
2198 .nr a| \n(dn |
2059 T} |
2199 .nr a- \n(dl |
2060 @see package.Class.NestedClass |
2200 .. |
2061 @see package.Class |
2201 .ec \ |
2062 @see package |
2202 .eo |
|
2203 .am 80 |
|
2204 .br |
|
2205 .di b+ |
|
2206 .35 |
|
2207 .ft \n(.f |
|
2208 .ll \n(34u*1u/2u |
|
2209 .if \n(.l<\n(80 .ll \n(80u |
|
2210 .in 0 |
|
2211 \f3憜鴻<潟若с\fP |
|
2212 .br |
|
2213 \f2@see\fP\ \f2#\fP\f2field\fP |
|
2214 .br |
|
2215 \f2@see\fP\ \f2#\fP\f2method(Type,\ Type,...)\fP |
|
2216 .br |
|
2217 \f2@see\fP\ \f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP |
|
2218 .br |
|
2219 \f2@see\fP\ \f2#\fP\f2constructor(Type,\ Type,...)\fP |
|
2220 .br |
|
2221 \f2@see\fP\ \f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP |
|
2222 .br |
|
2223 .di |
|
2224 .nr b| \n(dn |
|
2225 .nr b- \n(dl |
|
2226 .. |
|
2227 .ec \ |
|
2228 .eo |
|
2229 .am 80 |
|
2230 .br |
|
2231 .di c+ |
|
2232 .35 |
|
2233 .ft \n(.f |
|
2234 .ll \n(34u*1u/2u |
|
2235 .if \n(.l<\n(80 .ll \n(80u |
|
2236 .in 0 |
|
2237 \f3憜障ゃ潟若宴若吾ャ鴻с\fP |
|
2238 .br |
|
2239 \f2@see\fP\ \f2Class\fP\f2#\fP\f2field\fP |
|
2240 .br |
|
2241 \f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP |
|
2242 .br |
|
2243 \f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP |
|
2244 .br |
|
2245 \f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP |
|
2246 .br |
|
2247 \f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP |
|
2248 .br |
|
2249 \f2@see\fP\ \f2Class.NestedClass\fP |
|
2250 .br |
|
2251 \f2@see\fP\ \f2Class\fP |
|
2252 .br |
|
2253 .di |
|
2254 .nr c| \n(dn |
|
2255 .nr c- \n(dl |
|
2256 .. |
|
2257 .ec \ |
|
2258 .eo |
|
2259 .am 80 |
|
2260 .br |
|
2261 .di d+ |
|
2262 .35 |
|
2263 .ft \n(.f |
|
2264 .ll \n(34u*1u/2u |
|
2265 .if \n(.l<\n(80 .ll \n(80u |
|
2266 .in 0 |
|
2267 \f3ャ宴若吾荀膣с\fP\ (絎篆蕋) |
|
2268 .br |
|
2269 \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2field\fP |
|
2270 .br |
|
2271 \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP |
|
2272 .br |
|
2273 \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP |
|
2274 .br |
|
2275 \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP |
|
2276 .br |
|
2277 \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP |
|
2278 .br |
|
2279 \f2@see\fP\ \f2package.Class.NestedClass\fP |
|
2280 .br |
|
2281 \f2@see\fP\ \f2package.Class\fP |
|
2282 .br |
|
2283 \f2@see\fP\ \f2package\fP |
|
2284 .br |
|
2285 .di |
|
2286 .nr d| \n(dn |
|
2287 .nr d- \n(dl |
|
2288 .. |
|
2289 .ec \ |
|
2290 .35 |
|
2291 .nf |
|
2292 .ll \n(34u |
|
2293 .nr 80 0 |
|
2294 .80 |
|
2295 .rm 80 |
|
2296 .nr 38 \n(a- |
|
2297 .if \n(80<\n(38 .nr 80 \n(38 |
|
2298 .nr 38 \n(b- |
|
2299 .if \n(80<\n(38 .nr 80 \n(38 |
|
2300 .nr 38 \n(c- |
|
2301 .if \n(80<\n(38 .nr 80 \n(38 |
|
2302 .nr 38 \n(d- |
|
2303 .if \n(80<\n(38 .nr 80 \n(38 |
|
2304 .35 |
|
2305 .nf |
|
2306 .ll \n(34u |
|
2307 .nr 38 1n |
|
2308 .nr 79 0 |
|
2309 .nr 40 \n(79+(0*\n(38) |
|
2310 .nr 80 +\n(40 |
|
2311 .nr TW \n(80 |
|
2312 .if t .if \n(TW>\n(.li .tm Table at line 1861 file Input is too wide - \n(TW units |
|
2313 .fc |
|
2314 .nr #T 0-1 |
|
2315 .nr #a 0-1 |
|
2316 .eo |
|
2317 .de T# |
|
2318 .ds #d .d |
|
2319 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
2320 .mk ## |
|
2321 .nr ## -1v |
|
2322 .ls 1 |
|
2323 .ls |
|
2324 .. |
|
2325 .ec |
|
2326 .ne \n(a|u+\n(.Vu |
|
2327 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
2328 .ta \n(80u |
|
2329 .nr 31 \n(.f |
|
2330 .nr 35 1m |
|
2331 \&\h'|\n(40u' |
|
2332 .mk ## |
|
2333 .nr 31 \n(## |
|
2334 .sp |\n(##u-1v |
|
2335 .nr 37 \n(40u |
|
2336 .in +\n(37u |
|
2337 .a+ |
|
2338 .in -\n(37u |
|
2339 .mk 32 |
|
2340 .if \n(32>\n(31 .nr 31 \n(32 |
|
2341 .sp |\n(31u |
|
2342 .ne \n(b|u+\n(.Vu |
|
2343 .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) |
|
2344 .ta \n(80u |
|
2345 .nr 31 \n(.f |
|
2346 .nr 35 1m |
|
2347 \&\h'|\n(40u' |
|
2348 .mk ## |
|
2349 .nr 31 \n(## |
|
2350 .sp |\n(##u-1v |
|
2351 .nr 37 \n(40u |
|
2352 .in +\n(37u |
|
2353 .b+ |
|
2354 .in -\n(37u |
|
2355 .mk 32 |
|
2356 .if \n(32>\n(31 .nr 31 \n(32 |
|
2357 .sp |\n(31u |
|
2358 .ne \n(c|u+\n(.Vu |
|
2359 .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) |
|
2360 .ta \n(80u |
|
2361 .nr 31 \n(.f |
|
2362 .nr 35 1m |
|
2363 \&\h'|\n(40u' |
|
2364 .mk ## |
|
2365 .nr 31 \n(## |
|
2366 .sp |\n(##u-1v |
|
2367 .nr 37 \n(40u |
|
2368 .in +\n(37u |
|
2369 .c+ |
|
2370 .in -\n(37u |
|
2371 .mk 32 |
|
2372 .if \n(32>\n(31 .nr 31 \n(32 |
|
2373 .sp |\n(31u |
|
2374 .ne \n(d|u+\n(.Vu |
|
2375 .if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) |
|
2376 .ta \n(80u |
|
2377 .nr 31 \n(.f |
|
2378 .nr 35 1m |
|
2379 \&\h'|\n(40u' |
|
2380 .mk ## |
|
2381 .nr 31 \n(## |
|
2382 .sp |\n(##u-1v |
|
2383 .nr 37 \n(40u |
|
2384 .in +\n(37u |
|
2385 .d+ |
|
2386 .in -\n(37u |
|
2387 .mk 32 |
|
2388 .if \n(32>\n(31 .nr 31 \n(32 |
|
2389 .sp |\n(31u |
|
2390 .fc |
|
2391 .nr T. 1 |
|
2392 .T# 1 |
|
2393 .35 |
|
2394 .rm a+ |
|
2395 .rm b+ |
|
2396 .rm c+ |
|
2397 .rm d+ |
2063 .TE |
2398 .TE |
2064 .LP |
2399 .if \n-(b.=0 .nr c. \n(.c-\n(d.-58 |
2065 上の表に対する注を以下に示します。 |
2400 .RE |
2066 .LP |
2401 .RE |
2067 .TP 2 |
2402 |
2068 \(bu |
2403 .LP |
2069 クラスまたはパッケージを省いた最初の形式のセットでは、 |
2404 .RS 3 |
2070 .B javadoc |
2405 |
2071 ツールは現在のクラス階層だけで検索を行います。 |
2406 .LP |
2072 .B javadoc |
2407 .LP |
2073 ツールは、現在のクラスかインタフェースのメンバ、スーパークラスか |
2408 筝茵絲障茖莇割罨<腓冴障 |
2074 スーパーインタフェースの 1 つ、または |
2409 .LP |
2075 親クラスかインタフェースの 1 つ (検索手順 1 〜 3) を検索します。 |
2410 .RS 3 |
2076 現在のパッケージのほかの部分やほかのパッケージ (検索手順 4 〜 5) は |
2411 .TP 2 |
2077 検索しません。 |
2412 o |
2078 .TP 2 |
2413 腮蕁綵√ (宴若吾鴻) 翫Javadoc 若憜鴻絮ゃ罎膣≪障ゃ障憜鴻ゃ潟帥с若鴻鴻若若鴻鴻若若ゃ潟帥с若鴻障憜鴻ゃ潟帥с若鴻蚊с鴻ゃ潟帥с若鴻<潟若罎膣≪障 (罎膣∽ 1 3)憜宴若吾祉祉宴若吾罎膣≪障 (罎膣∽ 4 5) |
2079 \(bu |
2414 .TP 2 |
2080 メソッドまたはコンストラクタが、getValue のように |
2415 o |
2081 括弧を付けずに名前として入力され、 |
2416 <純障潟潟鴻帥絎綣с篁 (\f2getValue\fP ) 篏睡翫c若絖違Javadoc 若<純絲障罩c潟篏障 綣с綣違菴遵篆茘<祉若吾阪障<純若若若翫Javadoc 若罎膣≪ф荀ゃc<純潟障 腟c劫с障 |
2082 かつ同じ名前のフィールドがない場合は、 |
2417 .TP 2 |
2083 .B javadoc |
2418 o |
2084 ツールは正確にリンクを作成しますが、括弧と引数を追加するように |
2419 ャ絖鴻筝荐綵√翫\f2inner\fPс\f2outer\fP\f2.\fP\f2inner\fP絎違障 |
2085 促す警告メッセージを出力 |
2420 .TP 2 |
2086 します。このメソッドをオーバーロードした場合、 |
2421 o |
2087 .B javadoc |
2422 с菴違鴻鴻<潟若阪 (\f2.\fP) с激c若荐 (\f2#\fP) 篏睡羈絎Javadoc 若障茹f浦с障 鴻ャ絖鴻宴若吾潟泣宴若吾阪篏睡障Javadoc 若с筝荐怨合蚊綺障違с罩c頵f障 翫с茘茵腓冴障 |
2088 ツールは、指定されたメソッドではなく、検索で見つかった |
2423 .RE |
2089 最初のメソッドにリンクします。 |
2424 |
2090 .TP 2 |
2425 .LP |
2091 \(bu |
2426 .LP |
2092 入れ子の内部クラスは、どの形式の場合でも、単に |
2427 \f3@see 罎膣∫綺\fP \- Javadoc 若純若鴻<ゃ (.java)宴若吾<ゃ (package.html 障 package\-info.java)障网荀<ゃ (overview.html) 筝糸眼 \f2@see\fP 帥違障緇 2 ゃ<ゃс絎絎 \f2@see\fP 帥違絎違障純若鴻<ゃс絎絎障絎絎с障 |
2093 .BR inner |
2428 .LP |
2094 という形ではなく、 |
2429 .LP |
2095 .BR outer.inner |
2430 Javadoc 若\f2.java\fP <ゃу絎с荐菴違 \f2@see\fP 帥違荀ゃJava 潟潟ゃ綺ф絎罎膣≪障 Javadoc 若劫腥咲障罎冴障 純若鴻潟若若絖с罎膣∫綺Java 荐茯篁罕膃 2 膃 6 腴Namesфe絎臂障Javadoc 若∫c鴻宴若吾潟ゃ潟若鴻宴若吾鴻罎膣≪障隙罨<綺ф膣≪障 |
2096 という形で指定しなければなりません。 |
2431 .LP |
2097 .TP 2 |
2432 .RS 3 |
2098 \(bu |
2433 .TP 3 |
2099 すでに述べたとおり、クラスとメンバを区切るのに、ドット (\f3.\f1) ではなく |
2434 1. |
2100 ハッシュ文字 (\f3#\f1) が |
2435 憜鴻障ゃ潟帥с若 |
2101 使われていることに注意してください。ドットは、クラス、 |
2436 .TP 3 |
2102 入れ子のクラス、パッケージ、および |
2437 2. |
2103 サブパッケージを区切るのにも使われます。 |
2438 紊眼蚊с鴻ゃ潟帥с若 (c菴罎膣) |
2104 ただし、 |
2439 .TP 3 |
2105 .B javadoc |
2440 3. |
2106 ツールでは一般に許容範囲が広く、 |
2441 鴻若若鴻鴻若若ゃ潟帥с若 (c菴罎膣) |
2107 あいまいさがなければ、ドットでも正しく解析されます。 |
2442 .TP 3 |
2108 その場合でも警告は表示されます。 |
2443 4. |
2109 |
2444 憜宴若 |
2110 .LP |
2445 .TP 3 |
2111 .B @see の検索順序: |
2446 5. |
2112 .B javadoc |
2447 ゃ潟若宴若吾鴻潟ゃ潟帥с若 (import 綺緇c罎膣) |
2113 は、ソースファイル (\f3.java\f1)、パッケージ |
2448 .RE |
2114 ファイル (\f3package.html\f1 か \f3package\-info.java\f1)、または |
2449 |
2115 概要ファイル (\f3overview.html\f1) 内で使われる |
2450 .LP |
2116 .B @see |
2451 .LP |
2117 タグを処理します。 |
2452 Javadoc 若鴻ゃ 1 3 絽亥筝眼荀ゃ障ф膣≪膓障ゃ障障憜鴻罎膣≪罨<鴻蚊с E 罎膣≪罨< E 鴻若若鴻罎膣≪罨< E 蚊с鴻罎膣≪障 4 5 с1 ゃ宴若後鴻障ゃ潟帥с若鴻罎膣≪綺羆冴障c障 綺潟潟ゃc違障 5 сJavadoc 若java.lang 罎膣≪障 宴若吾鴻違ゃ潟若с |
2118 あとの 2 つのファイルでは、 |
2453 .LP |
2119 .BR @see |
2454 .LP |
2120 を使って指定する名前を完全修飾する必要があります。 |
2455 Javadoc 若綽泣鴻罎膣≪障 障javadoc 絎茵筝祉宴若吾ャ<潟翫с祉宴若吾罎膣≪障違\f2@see\fP 帥違 \f2java.awt.event.KeyEvent\fP 劫c\f2java.awt\fP 宴若吾с翫Javadoc 鴻ゃ潟若宴若吾罎膣≪障 |
2121 ソースファイルでは、完全修飾名 |
2456 .LP |
2122 と部分修飾名のどちらを指定することもできます。 |
2457 .LP |
2123 .LP |
2458 \f3茵腓冴号\fP \- \f2label\fP ャ\f2package.class.member\fP 茵腓冴障筝package.class.member 憜鴻潟宴若吾綽膰障膰綽荀絨茵腓冴с違\f2String.toUpperCase()\fP <純鴻<潟若吾с祉鴻<潟若吾с障翫劫茵腓冴緇宴若鴻с (罨<茵) |
2124 .B javadoc |
2459 .LP |
2125 ツールが、完全修飾されていない |
2460 .LP |
2126 .B .java |
2461 宴若後綺ゃ\-noqualifier 篏睡障 |
2127 ファイルで |
2462 .br |
2128 .B @see |
2463 |
2129 タグを見つけた場合、指定された名前を Java コンパイラと |
2464 .LP |
2130 同じ順序で検索します。ただし、 |
2465 .RE |
2131 .B javadoc |
2466 .RS 3 |
2132 ツールは、一部の名前空間のあいまいさは検出しません。これは、 |
2467 .RS 3 |
2133 .B javadoc |
2468 .LP |
2134 ツールが、ソースコードにこれらのエラーが存在していないことを |
|
2135 前提として動作するためです。 |
|
2136 検索順序は、「Java Language Specification」第 2 版の第 6 章「Names」で |
|
2137 正式に定義されています。具体的には、検索は次の順序で行われます。 |
|
2138 .LP |
|
2139 .TP 4 |
|
2140 1. |
|
2141 現在のクラスまたはインタフェース |
|
2142 .PD 0 |
|
2143 .TP 4 |
|
2144 2. |
|
2145 名前を囲むクラスとインタフェース。もっとも近いものを最初に検索 |
|
2146 .TP 4 |
|
2147 3. |
|
2148 スーパークラスとスーパーインタフェース。もっとも近いものを最初に検索 |
|
2149 .TP 4 |
|
2150 4. |
|
2151 現在のパッケージ |
|
2152 .TP 4 |
|
2153 5. |
|
2154 インポートされるパッケージ、クラス、 |
|
2155 およびインタフェース。import 文の順序に従って検索 |
|
2156 .PD |
|
2157 .LP |
|
2158 .B javadoc |
|
2159 ツールは、一致する名前が見つかるまで、各クラスについて |
|
2160 手順 1 〜 3 を繰り返して検索を続け |
|
2161 ます。つまり、現在のクラスとそのクラスを囲む |
|
2162 クラス E を検索したあと、E のスーパクラスを |
|
2163 検索し、最後に E を囲むクラスを検索します。手順 4 と 5 では、 |
|
2164 .B javadoc |
|
2165 ツールは、1 つのパッケージ内でのクラスまたはインタフェースの検索を、 |
|
2166 なんらかの決まった順 |
|
2167 序で行うわけではありません (この検索順序はコンパイラに依存します)。 |
|
2168 手順 5 では、 |
|
2169 .B javadoc |
|
2170 ツールは、 |
|
2171 .BR java.lang |
|
2172 を検索します。これは、 |
|
2173 .BR java.lang |
|
2174 がすべてのプログラムによって自動的にインポートされるためです。 |
|
2175 .LP |
|
2176 .B javadoc |
|
2177 ツールは、必ずしもサブクラスを検索するわけではなく、Javadoc ツールの |
|
2178 実行中にほかのパッケージ |
|
2179 のドキュメントが生成される場合でも、ほかのパッケージの |
|
2180 検索は行いません。 |
|
2181 たとえば、 |
|
2182 .B @see |
|
2183 タグが |
|
2184 .B java.awt.event.KeyEvent |
|
2185 クラスにあって、 |
|
2186 .B java.awt |
|
2187 パッケージにある名前を参照する場合、 |
|
2188 .B javadoc |
|
2189 は、そのクラスがインポートしない限りそのパッケージを検索しません。 |
|
2190 .LP |
|
2191 .B 名前の表示方法: |
|
2192 .I label |
|
2193 が省略された場合は、 |
|
2194 .I package.class.member |
|
2195 が表示されます。通常、package.class.member は、現在の |
|
2196 クラスおよびパッケージに |
|
2197 応じて適切に短くされます。「短くされる」とは、 |
|
2198 .B javadoc |
|
2199 ツールが必要最小限の名前を表示するということです。 |
|
2200 たとえば、String.toUpperCase() メソッドが同じ |
|
2201 クラスのメンバへの参照と、別のクラスのメンバへの |
|
2202 参照を含んでいる場合、クラス名は後者の場合だけ表示されます。 |
|
2203 .LP |
|
2204 パッケージ名を広域的に削除するには、\-noqualifier を使用します。 |
|
2205 .br |
|
2206 .LP |
|
2207 .TP 4 |
|
2208 .TS |
2469 .TS |
2209 box, center; |
2470 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2210 cbp-1 | cbp-1 | cbp-1 |
2471 .de 35 |
2211 l | l | l . |
2472 .ps \n(.s |
2212 参照の種類 T{ |
2473 .vs \n(.vu |
2213 String.toUppercase() での例 |
2474 .in \n(.iu |
2214 T} 表示 |
2475 .if \n(.u .fi |
2215 _ |
2476 .if \n(.j .ad |
2216 T{ |
2477 .if \n(.j=0 .na |
2217 @see タグが同じクラス、同じパッケージのメンバを参照している |
2478 .. |
2218 T} T{ |
2479 .nf |
2219 @see String#toLowerCase() |
2480 .nr #~ 0 |
2220 T} T{ |
2481 .if n .nr #~ 0.6n |
2221 toLowerCase() (パッケージおよびクラス名は省略) |
2482 .ds #d .d |
2222 T} |
2483 .if \(ts\n(.z\(ts\(ts .ds #d nl |
2223 _ |
2484 .fc |
2224 T{ |
2485 .nr 33 \n(.s |
2225 @see タグが異なるクラス、同じパッケージのメンバを参照している |
2486 .rm 80 81 82 |
2226 T} T{ |
2487 .nr 34 \n(.lu |
2227 @see Character#toLowerCase(char) |
2488 .eo |
2228 T} T{ |
2489 .am 81 |
2229 Character.toLowerCase(char) (パッケージ名は省略し、クラス名を含む) |
2490 .br |
2230 T} |
2491 .di a+ |
2231 _ |
2492 .35 |
2232 T{ |
2493 .ft \n(.f |
2233 @see タグが異なるクラス、異なるパッケージのメンバを参照している |
2494 .ll \n(34u*1u/4u |
2234 T} T{ |
2495 .if \n(.l<\n(81 .ll \n(81u |
2235 @see java.io.File#exists() |
2496 .in 0 |
2236 T} T{ |
2497 \f4String.toUpperCase()\fP\f3 с箴\fP |
2237 java.io.File.exists() (パッケージ名とクラス名を含む) |
2498 .br |
2238 T} |
2499 .di |
|
2500 .nr a| \n(dn |
|
2501 .nr a- \n(dl |
|
2502 .. |
|
2503 .ec \ |
|
2504 .eo |
|
2505 .am 80 |
|
2506 .br |
|
2507 .di b+ |
|
2508 .35 |
|
2509 .ft \n(.f |
|
2510 .ll \n(34u*1u/4u |
|
2511 .if \n(.l<\n(80 .ll \n(80u |
|
2512 .in 0 |
|
2513 \f2@see\fP 帥違鴻<潟若с |
|
2514 .br |
|
2515 .di |
|
2516 .nr b| \n(dn |
|
2517 .nr b- \n(dl |
|
2518 .. |
|
2519 .ec \ |
|
2520 .eo |
|
2521 .am 82 |
|
2522 .br |
|
2523 .di c+ |
|
2524 .35 |
|
2525 .ft \n(.f |
|
2526 .ll \n(34u*1u/4u |
|
2527 .if \n(.l<\n(82 .ll \n(82u |
|
2528 .in 0 |
|
2529 \f2toLowerCase()\fP (劫) |
|
2530 .br |
|
2531 .di |
|
2532 .nr c| \n(dn |
|
2533 .nr c- \n(dl |
|
2534 .. |
|
2535 .ec \ |
|
2536 .eo |
|
2537 .am 80 |
|
2538 .br |
|
2539 .di d+ |
|
2540 .35 |
|
2541 .ft \n(.f |
|
2542 .ll \n(34u*1u/4u |
|
2543 .if \n(.l<\n(80 .ll \n(80u |
|
2544 .in 0 |
|
2545 \f2@see\fP 帥違ャ鴻<潟若с |
|
2546 .br |
|
2547 .di |
|
2548 .nr d| \n(dn |
|
2549 .nr d- \n(dl |
|
2550 .. |
|
2551 .ec \ |
|
2552 .eo |
|
2553 .am 81 |
|
2554 .br |
|
2555 .di e+ |
|
2556 .35 |
|
2557 .ft \n(.f |
|
2558 .ll \n(34u*1u/4u |
|
2559 .if \n(.l<\n(81 .ll \n(81u |
|
2560 .in 0 |
|
2561 \f2@see Character#toLowerCase(char)\fP |
|
2562 .br |
|
2563 .di |
|
2564 .nr e| \n(dn |
|
2565 .nr e- \n(dl |
|
2566 .. |
|
2567 .ec \ |
|
2568 .eo |
|
2569 .am 82 |
|
2570 .br |
|
2571 .di f+ |
|
2572 .35 |
|
2573 .ft \n(.f |
|
2574 .ll \n(34u*1u/4u |
|
2575 .if \n(.l<\n(82 .ll \n(82u |
|
2576 .in 0 |
|
2577 \f2Character.toLowerCase(char)\fP (宴若後ャ劫) |
|
2578 .br |
|
2579 .di |
|
2580 .nr f| \n(dn |
|
2581 .nr f- \n(dl |
|
2582 .. |
|
2583 .ec \ |
|
2584 .eo |
|
2585 .am 80 |
|
2586 .br |
|
2587 .di g+ |
|
2588 .35 |
|
2589 .ft \n(.f |
|
2590 .ll \n(34u*1u/4u |
|
2591 .if \n(.l<\n(80 .ll \n(80u |
|
2592 .in 0 |
|
2593 \f2@see\fP 帥違ャ鴻<潟若с |
|
2594 .br |
|
2595 .di |
|
2596 .nr g| \n(dn |
|
2597 .nr g- \n(dl |
|
2598 .. |
|
2599 .ec \ |
|
2600 .eo |
|
2601 .am 81 |
|
2602 .br |
|
2603 .di h+ |
|
2604 .35 |
|
2605 .ft \n(.f |
|
2606 .ll \n(34u*1u/4u |
|
2607 .if \n(.l<\n(81 .ll \n(81u |
|
2608 .in 0 |
|
2609 \f2@see java.io.File#exists()\fP |
|
2610 .br |
|
2611 .di |
|
2612 .nr h| \n(dn |
|
2613 .nr h- \n(dl |
|
2614 .. |
|
2615 .ec \ |
|
2616 .eo |
|
2617 .am 82 |
|
2618 .br |
|
2619 .di i+ |
|
2620 .35 |
|
2621 .ft \n(.f |
|
2622 .ll \n(34u*1u/4u |
|
2623 .if \n(.l<\n(82 .ll \n(82u |
|
2624 .in 0 |
|
2625 \f2java.io.File.exists()\fP (宴若後劫) |
|
2626 .br |
|
2627 .di |
|
2628 .nr i| \n(dn |
|
2629 .nr i- \n(dl |
|
2630 .. |
|
2631 .ec \ |
|
2632 .35 |
|
2633 .nf |
|
2634 .ll \n(34u |
|
2635 .nr 80 0 |
|
2636 .nr 38 \w\f3с腮蕁\fP |
|
2637 .if \n(80<\n(38 .nr 80 \n(38 |
|
2638 .80 |
|
2639 .rm 80 |
|
2640 .nr 38 \n(b- |
|
2641 .if \n(80<\n(38 .nr 80 \n(38 |
|
2642 .nr 38 \n(d- |
|
2643 .if \n(80<\n(38 .nr 80 \n(38 |
|
2644 .nr 38 \n(g- |
|
2645 .if \n(80<\n(38 .nr 80 \n(38 |
|
2646 .nr 81 0 |
|
2647 .nr 38 \w\f2@see String#toLowerCase()\fP |
|
2648 .if \n(81<\n(38 .nr 81 \n(38 |
|
2649 .81 |
|
2650 .rm 81 |
|
2651 .nr 38 \n(a- |
|
2652 .if \n(81<\n(38 .nr 81 \n(38 |
|
2653 .nr 38 \n(e- |
|
2654 .if \n(81<\n(38 .nr 81 \n(38 |
|
2655 .nr 38 \n(h- |
|
2656 .if \n(81<\n(38 .nr 81 \n(38 |
|
2657 .nr 82 0 |
|
2658 .nr 38 \w\f3茵腓冴\fP |
|
2659 .if \n(82<\n(38 .nr 82 \n(38 |
|
2660 .82 |
|
2661 .rm 82 |
|
2662 .nr 38 \n(c- |
|
2663 .if \n(82<\n(38 .nr 82 \n(38 |
|
2664 .nr 38 \n(f- |
|
2665 .if \n(82<\n(38 .nr 82 \n(38 |
|
2666 .nr 38 \n(i- |
|
2667 .if \n(82<\n(38 .nr 82 \n(38 |
|
2668 .35 |
|
2669 .nf |
|
2670 .ll \n(34u |
|
2671 .nr 38 1n |
|
2672 .nr 79 0 |
|
2673 .nr 40 \n(79+(0*\n(38) |
|
2674 .nr 80 +\n(40 |
|
2675 .nr 41 \n(80+(3*\n(38) |
|
2676 .nr 81 +\n(41 |
|
2677 .nr 42 \n(81+(3*\n(38) |
|
2678 .nr 82 +\n(42 |
|
2679 .nr TW \n(82 |
|
2680 .if t .if \n(TW>\n(.li .tm Table at line 1959 file Input is too wide - \n(TW units |
|
2681 .fc |
|
2682 .nr #T 0-1 |
|
2683 .nr #a 0-1 |
|
2684 .eo |
|
2685 .de T# |
|
2686 .ds #d .d |
|
2687 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
2688 .mk ## |
|
2689 .nr ## -1v |
|
2690 .ls 1 |
|
2691 .ls |
|
2692 .. |
|
2693 .ec |
|
2694 .ne \n(a|u+\n(.Vu |
|
2695 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
2696 .ta \n(80u \n(81u \n(82u |
|
2697 .nr 31 \n(.f |
|
2698 .nr 35 1m |
|
2699 \&\h'|\n(40u'\f3с腮蕁\fP\h'|\n(41u'\h'|\n(42u'\f3茵腓冴\fP |
|
2700 .mk ## |
|
2701 .nr 31 \n(## |
|
2702 .sp |\n(##u-1v |
|
2703 .nr 37 \n(41u |
|
2704 .in +\n(37u |
|
2705 .a+ |
|
2706 .in -\n(37u |
|
2707 .mk 32 |
|
2708 .if \n(32>\n(31 .nr 31 \n(32 |
|
2709 .sp |\n(31u |
|
2710 .ne \n(b|u+\n(.Vu |
|
2711 .ne \n(c|u+\n(.Vu |
|
2712 .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) |
|
2713 .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) |
|
2714 .ta \n(80u \n(81u \n(82u |
|
2715 .nr 31 \n(.f |
|
2716 .nr 35 1m |
|
2717 \&\h'|\n(40u'\h'|\n(41u'\f2@see String#toLowerCase()\fP\h'|\n(42u' |
|
2718 .mk ## |
|
2719 .nr 31 \n(## |
|
2720 .sp |\n(##u-1v |
|
2721 .nr 37 \n(40u |
|
2722 .in +\n(37u |
|
2723 .b+ |
|
2724 .in -\n(37u |
|
2725 .mk 32 |
|
2726 .if \n(32>\n(31 .nr 31 \n(32 |
|
2727 .sp |\n(##u-1v |
|
2728 .nr 37 \n(42u |
|
2729 .in +\n(37u |
|
2730 .c+ |
|
2731 .in -\n(37u |
|
2732 .mk 32 |
|
2733 .if \n(32>\n(31 .nr 31 \n(32 |
|
2734 .sp |\n(31u |
|
2735 .ne \n(d|u+\n(.Vu |
|
2736 .ne \n(e|u+\n(.Vu |
|
2737 .ne \n(f|u+\n(.Vu |
|
2738 .if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) |
|
2739 .if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) |
|
2740 .if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) |
|
2741 .ta \n(80u \n(81u \n(82u |
|
2742 .nr 31 \n(.f |
|
2743 .nr 35 1m |
|
2744 \&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' |
|
2745 .mk ## |
|
2746 .nr 31 \n(## |
|
2747 .sp |\n(##u-1v |
|
2748 .nr 37 \n(40u |
|
2749 .in +\n(37u |
|
2750 .d+ |
|
2751 .in -\n(37u |
|
2752 .mk 32 |
|
2753 .if \n(32>\n(31 .nr 31 \n(32 |
|
2754 .sp |\n(##u-1v |
|
2755 .nr 37 \n(41u |
|
2756 .in +\n(37u |
|
2757 .e+ |
|
2758 .in -\n(37u |
|
2759 .mk 32 |
|
2760 .if \n(32>\n(31 .nr 31 \n(32 |
|
2761 .sp |\n(##u-1v |
|
2762 .nr 37 \n(42u |
|
2763 .in +\n(37u |
|
2764 .f+ |
|
2765 .in -\n(37u |
|
2766 .mk 32 |
|
2767 .if \n(32>\n(31 .nr 31 \n(32 |
|
2768 .sp |\n(31u |
|
2769 .ne \n(g|u+\n(.Vu |
|
2770 .ne \n(h|u+\n(.Vu |
|
2771 .ne \n(i|u+\n(.Vu |
|
2772 .if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) |
|
2773 .if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) |
|
2774 .if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) |
|
2775 .ta \n(80u \n(81u \n(82u |
|
2776 .nr 31 \n(.f |
|
2777 .nr 35 1m |
|
2778 \&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' |
|
2779 .mk ## |
|
2780 .nr 31 \n(## |
|
2781 .sp |\n(##u-1v |
|
2782 .nr 37 \n(40u |
|
2783 .in +\n(37u |
|
2784 .g+ |
|
2785 .in -\n(37u |
|
2786 .mk 32 |
|
2787 .if \n(32>\n(31 .nr 31 \n(32 |
|
2788 .sp |\n(##u-1v |
|
2789 .nr 37 \n(41u |
|
2790 .in +\n(37u |
|
2791 .h+ |
|
2792 .in -\n(37u |
|
2793 .mk 32 |
|
2794 .if \n(32>\n(31 .nr 31 \n(32 |
|
2795 .sp |\n(##u-1v |
|
2796 .nr 37 \n(42u |
|
2797 .in +\n(37u |
|
2798 .i+ |
|
2799 .in -\n(37u |
|
2800 .mk 32 |
|
2801 .if \n(32>\n(31 .nr 31 \n(32 |
|
2802 .sp |\n(31u |
|
2803 .fc |
|
2804 .nr T. 1 |
|
2805 .T# 1 |
|
2806 .35 |
|
2807 .rm a+ |
|
2808 .rm b+ |
|
2809 .rm c+ |
|
2810 .rm d+ |
|
2811 .rm e+ |
|
2812 .rm f+ |
|
2813 .rm g+ |
|
2814 .rm h+ |
|
2815 .rm i+ |
2239 .TE |
2816 .TE |
2240 .LP |
2817 .if \n-(b.=0 .nr c. \n(.c-\n(d.-28 |
2241 \f3@see の例\fP |
2818 .RE |
2242 .br |
2819 .RE |
2243 右側のコメントは、\f2@see\fP タグが別のパッケージ (\f2java.applet.Applet\fP など) のクラス内にある場合に、名前がどのように表示されるかを示しています。 |
2820 |
2244 .nf |
2821 .LP |
2245 \f3 |
2822 .RS 3 |
2246 .fl |
2823 |
2247 See also: |
2824 .LP |
|
2825 .LP |
|
2826 \f3@see 箴\fP |
|
2827 .br |
|
2828 勀眼潟<潟\f2@see\fP 帥違ャ宴若 (\f2java.applet.Applet\fP ) 劫翫茵腓冴腓冴障 |
|
2829 .LP |
|
2830 .nf |
|
2831 \f3 |
|
2832 .fl |
|
2833 ∫i: |
2248 .fl |
2834 .fl |
2249 @see java.lang.String // String \fP\f3 |
2835 @see java.lang.String // String \fP\f3 |
2250 .fl |
2836 .fl |
2251 @see java.lang.String The String class // The String class \fP\f3 |
2837 @see java.lang.String The String class // The String class \fP\f3 |
2252 .fl |
2838 .fl |
2262 .fl |
2848 .fl |
2263 @see <a href="spec.html">Java Spec</a> // Java Spec \fP\f3 |
2849 @see <a href="spec.html">Java Spec</a> // Java Spec \fP\f3 |
2264 .fl |
2850 .fl |
2265 @see "The Java Programming Language" // "The Java Programming Language" \fP\f3 |
2851 @see "The Java Programming Language" // "The Java Programming Language" \fP\f3 |
2266 .fl |
2852 .fl |
2267 \fP |
2853 |
2268 .fi |
2854 .fl |
2269 .I @see |
2855 \fP |
2270 を、ドキュメント化の対象にしていないクラスにまで拡張するには、 |
2856 .fi |
2271 .I -link |
2857 |
2272 オプションを使用します。 |
2858 .LP |
2273 .LP |
2859 .LP |
2274 詳細については、 |
2860 \f2@see\fP ャ<潟絲乗院鴻障ф≦宍\f2\-link\fP 激с潟篏睡障 |
2275 .fi |
2861 .LP |
2276 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@see |
2862 .LP |
2277 の |
2863 荅括完ゃ |
2278 .na |
2864 .na |
2279 \f2@see タグのドキュメント\fPを参照してください。 |
2865 \f2@see 帥違ャ<潟\fP @ |
2280 .RE |
2866 .fi |
2281 .TP 3 |
2867 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@seeс |
2282 .BI @serial " field-description" | include | exclude |
2868 .LP |
2283 デフォルトの直列化可能フィールドの doc コメントで使用します。 |
2869 .RE |
2284 .RS |
2870 .LP |
2285 .LP |
2871 |
2286 省略可能な field-description は、 |
2872 .LP |
2287 フィールドの doc コメントを拡張します。 |
2873 .RS 3 |
2288 この説明では、フィールドの意味および |
2874 .TP 3 |
2289 取り得る値のリストを指定しなければなりません。 |
2875 @serial\ field\-description | include | exclude |
2290 必要な場合には、複数の行にまたがって説明を記述することができます。 |
2876 翫純c若ャ<潟若激с潟潟<潟т戎障 |
2291 標準ドックレットは、この情報を、直列化された形式のページに追加します。 |
2877 .RE |
2292 .LP |
2878 |
2293 クラスを直列化したあとしばらくしてから直列化可能フィールドをクラスに追加した場合、主説明に、追加したバージョンを識別する文を追加する必要があります。 |
2879 .LP |
2294 .LP |
2880 .RS 3 |
2295 .BR include |
2881 |
2296 と |
2882 .LP |
2297 .BR exclude |
2883 .LP |
2298 引数は、直列化された形式のページにクラスまたはパッケージを含めるべきか、 |
2884 \f2field\-description\fP (ュ) сc若潟茯緇ゃ鴻腓冴綽荀障綽荀綽茲違茵羝<c茯荐菴違с障罔羣宴翫綵√若吾菴遵障 |
2299 あるいはこれらの引数を除くべきかを指定します。 |
2885 .LP |
2300 これらは、次のように動作します。 |
2886 .LP |
2301 .LP |
2887 鴻翫違翫純c若鴻菴遵翫筝肢菴遵若吾с潟茘ャ菴遵綽荀障 |
2302 .TP 2 |
2888 .LP |
2303 \(bu |
2889 .LP |
2304 .BR Serializable |
2890 \f2include\fP \f2exclude\fP 綣違翫綵√若吾鴻障宴若吾ゅ腓冴障綣違罨<号障 |
2305 を実装する public クラスまたは protected クラスは、 |
2891 .LP |
2306 そのクラス (またはそのパッケージ) が |
2892 .RS 3 |
2307 .BR @serial |
2893 .TP 2 |
2308 .BR exclude |
2894 o |
2309 とマークされていない限り含められます。 |
2895 \f2Serializable\fP 絎茖 public 障 protected 鴻絽吾若吾障 鴻障鴻絮宴若吾 \f2@serial exclude\fP ф絎若吾ゅ障 |
2310 .TP 2 |
2896 .TP 2 |
2311 \(bu |
2897 o |
2312 .BR Serializable |
2898 \f2Serializable\fP 絎茖 private 障 package private 鴻絽吾若吾ゅ障 鴻障鴻絮宴若吾 \f2@serial include\fP ф絎若吾障 |
2313 を実装する private クラスまたは package\-private クラスは、 |
2899 .RE |
2314 そのクラス (またはそのパッケージ) が |
2900 |
2315 .BR @serial |
2901 .LP |
2316 .BR include |
2902 .LP |
2317 とマークされていない限り除かれます。 |
2903 箴: \f2javax.swing\fP 宴若吾\f2@serial exclude\fP ф絎障 (\f2package.html\fP 障 \f2package\-info.java\fP )public \f2java.security.BasicPermission\fP \f2@serial exclude\fP ф絎障package private \f2java.util.PropertyPermissionCollection\fP \f2@serial include\fP ф絎障 |
2318 .LP |
2904 .LP |
2319 例: |
2905 .LP |
2320 .BR javax.swing |
2906 鴻ф絎 @serial 帥違宴若吾ф絎 @serial 帥違若若ゃ障 |
2321 パッケージは、(package.html または \f2package\-info.java\fP 内で) |
2907 .LP |
2322 .BR @serial |
2908 .LP |
2323 .BR exclude |
2909 帥違篏睡羈ゃ荅括完篏睡箴Java 吾с翫篁罕膃 1.6 膀 |
2324 とマークされます。 |
|
2325 public クラスである |
|
2326 .BR java.sercurity.BasicPermission |
|
2327 は、 |
|
2328 .BR @serial |
|
2329 .BR exclude |
|
2330 とマークされます。package\-private クラスである |
|
2331 .BR java.util.PropertyPermissionCollection |
|
2332 は、 |
|
2333 .BR @serial |
|
2334 .BR include |
|
2335 とマークされます。 |
|
2336 .LP |
|
2337 クラスレベルのタグ |
|
2338 .BR @serial |
|
2339 は、パッケージレベルの |
|
2340 .BR @serial |
|
2341 をオーバーライドします。 |
|
2342 .LP |
|
2343 これらのタグの使用法についての詳細と使用例は、「Java オブジェクト直列化仕様」の第 1.6 節「クラスの直列化可能なフィールドおよびデータの文書化」を参照してください。また、 |
|
2344 .fi |
|
2345 http://java.sun.com/products/jdk/serialization/faq/#javadoc_warn_missing |
|
2346 の |
|
2347 .na |
2910 .na |
2348 「\f2直列化の FAQ\fP」も参照してください。この FAQ には、「\-private スイッチを指定しないで javadoc を実行しているのに private フィールドの @serial タグが見つからないという javadoc の警告が表示される」などの一般的な質問への回答が記載されています。直列化形式仕様にクラスを含める場合には、 |
2911 \f2鴻翫純c若潟若帥後\fP @ |
2349 .fi |
2912 .fi |
2350 http://java.sun.com/j2se/javadoc/writingapispecs/serialized\-criteria.html |
2913 http://java.sun.com/javase/6/docs/platform/serialization/spec/serial\-arch.htmlс障 |
2351 の |
|
2352 .na |
2914 .na |
2353 「\f2Sun の仕様\fP」も参照してください。 |
2915 \f2翫 FAQ\fP @ |
2354 .LP |
2916 .fi |
2355 .RE |
2917 http://java.sun.com/products/jdk/serialization/faq/#javadoc_warn_missingс FAQ \-private 鴻ゃ絎 javadoc 絎茵 private c若 @serial 帥違荀ゃ javadoc 茘茵腓冴筝莖吾膈荐莠障翫綵√鋌罕鴻翫 |
2356 .TP |
2918 .na |
2357 .BI @serialField " field-name field-type field-description" |
2919 \f2Sun 篁罕\fP @ |
2358 Serializable クラスの serialPersistentFields メンバの ObjectStreamField コンポーネント |
2920 .fi |
2359 をドキュメント化します。各 ObjectStreamField コンポーネントに対して |
2921 http://java.sun.com/j2se/javadoc/writingapispecs/serialized\-criteria.htmlс |
2360 .B @serialField |
2922 .LP |
2361 タグを 1 つ使う必要があります。 |
2923 .LP |
2362 .TP |
2924 |
2363 .BI @serialData " data-description" |
2925 .LP |
2364 .I data-description |
2926 .RE |
2365 は、直列化された形式でのデータの型と順序を |
2927 .RS 3 |
2366 説明するテキストです。 このデータには、 |
2928 .TP 3 |
2367 特に、writeObject メソッドによって書き込まれる省略可能な |
2929 @serialField\ field\-name\ field\-type\ field\-description |
2368 データ、および Externalizable.writeExternal メソッドによって |
2930 \f2Serializable\fP 鴻 \f2serialPersistentFields\fP <潟若 \f2ObjectStreamField\fP 潟潟若潟ャ<潟障 \f2ObjectStreamField\fP 潟潟若潟絲障 \f2@serialField\fP 帥違 1 や戎綽荀障 |
2369 書き込まれるすべてのデータ (基底クラスを含む) が含まれます。 |
2931 .RE |
2370 .TP |
2932 |
2371 .B @serialData |
2933 .LP |
2372 タグは、writeObject、readObject、writeExternal、および readExternal の各メソッドの |
2934 .RS 3 |
2373 doc コメントで使用できます。 |
2935 |
2374 .LP |
2936 .LP |
|
2937 .LP |
|
2938 |
|
2939 .LP |
|
2940 .RE |
|
2941 .RS 3 |
|
2942 .TP 3 |
|
2943 @serialData\ data\-description |
|
2944 \f2data\-description\fP 翫綵√с若帥綺茯鴻с若帥鴻\f2writeObject\fP <純c吾莨若障ュ純若帥 \f2Externalizable.writeExternal\fP <純c吾莨若障鴻若 (阪鴻) 障障 |
|
2945 .RE |
|
2946 |
|
2947 .LP |
|
2948 .RS 3 |
|
2949 |
|
2950 .LP |
|
2951 .LP |
|
2952 \f2@serialData\fP 帥違\f2writeObject\fP\f2readObject\fP\f2writeExternal\fP\f2readExternal\fP\f2writeReplace\fP \f2readResolve\fP <純ャ<潟若激с潟潟<潟т戎с障 |
|
2953 .LP |
|
2954 .LP |
|
2955 |
|
2956 .LP |
|
2957 .RE |
|
2958 .RS 3 |
2375 .TP 3 |
2959 .TP 3 |
2376 @since\ since\-text |
2960 @since\ since\-text |
2377 生成ドキュメントに「導入されたバージョン」見出しを追加し、指定された \f2since\-text\fP を書き込みます。このテキストには、特別な内部構造はありません。このタグは、すべてのドキュメンテーションコメント、つまり概要、パッケージ、クラス、インタフェース、コンストラクタ、メソッド、およびフィールドで有効です。このタグは、特定の変更または機能が、\f2since\-text\fP に示されたソフトウェアリリース以降、存在していることを意味します。次に例を示します。 |
2961 ャ<潟 [絨ャ若吾с] 荀冴菴遵絎 \f2since\-text\fP 吾莨若帥障鴻劫ャ罕障帥違鴻ャ<潟若激с潟潟<潟ゃ障网荀宴若吾鴻ゃ潟帥с若鴻潟潟鴻帥<純潟c若ф鴻с帥違劫紊眼障罘純\f2since\-text\fP 腓冴純с≪若剛札絖潟障箴腓冴障 |
|
2962 .RE |
|
2963 |
|
2964 .LP |
|
2965 .RS 3 |
|
2966 |
|
2967 .LP |
2378 .nf |
2968 .nf |
2379 \f3 |
2969 \f3 |
2380 .fl |
2970 .fl |
2381 @since 1.5 |
2971 @since 1.5 |
2382 .fl |
2972 .fl |
2383 \fP |
2973 |
2384 .fi |
2974 .fl |
2385 Java プラットフォームのソースコードの場合、このタグは、Java プラットフォーム API 仕様のバージョンを示します。その変更や機能がリファレンス実装に追加された時期を示すとは限りません。複数の @since タグを使用でき、複数の @author タグのように扱われます。プログラム要素が複数の API で使用される場合、複数のタグを使用できます。 |
2975 \fP |
2386 .RE |
2976 .fi |
2387 .TP |
2977 |
2388 .BI @throws " class-name description" |
2978 .LP |
2389 .B @throws |
2979 .LP |
2390 タグと |
2980 Java 若純若鴻潟若翫帥違Java 若 API 篁罕若吾с潟腓冴障 紊眼罘純<潟劫茖菴遵腓冴障茲違 @since 帥違篏睡с茲違 @author 帥違宴障違荀膣茲違 API т戎翫茲違帥違篏睡с障 |
2391 .B @exception |
2981 .LP |
2392 タグは同義です。生成されるドキュメンテーションに、 |
2982 .LP |
2393 .I class-name |
2983 |
2394 および |
2984 .LP |
2395 .I description |
2985 .RE |
2396 テキストを持つ [例外] 小見出しを追加します。 |
2986 .RS 3 |
2397 .I class-name |
2987 .TP 3 |
2398 は、該当するメソッドによって |
2988 @throws\ class\-name\ description\ |
2399 スローされる可能性のある例外の名前です。このタグは、doc コメントまたはコンストラクタでのみ有効です。このクラスが完全 |
2989 \f2@throws\fP 帥違 \f2@exception\fP 帥違臂сャ<潟 [箴紊] 絨頳冴菴遵\f2class\-name\fP \f2description\fP 鴻吾莨若帥障\f2class\-name\fP <純鴻若醇с箴紊с帥違<純潟潟鴻帥 doc 潟<潟с炊鴻с鴻絎絎ц菴違翫Javadoc 若罎膣∫綺緇c鴻「障障違箴紊 doc 潟<潟с茲違 \f2@throws\fP 帥違篏睡с障 |
2400 修飾されていない場合、 |
2990 .RE |
2401 .B javadoc |
2991 |
2402 ツールは検索順序に従ってクラスを探します。 |
2992 .LP |
2403 同じまたは異なる例外の doc コメントで、 |
2993 .RS 3 |
2404 複数の @throws タグを使用できます。 |
2994 |
2405 .LP |
2995 .LP |
2406 すべてのチェック済み例外がドキュメント化されるようにするために、 |
2996 .LP |
2407 @throws タグが throws 節内の例外用に存在しない場合は、 |
2997 鴻с羝推紊ャ<潟\f2@throws\fP 帥違 throws 膀箴紊絖翫@throws 帥違ャ<潟сJavadoc 若c箴紊 HTML 阪茯ц菴遵障 |
2408 @throws タグのあるドキュメントであるかのように、 |
2998 .LP |
2409 .B Javadoc |
2999 .LP |
2410 ツールによって例外が HTML 出力に説明なしで |
3000 若若ゃ<純т紊腓榊絎h翫帥\f2@throws\fP ャ<潟若激с潟<純泣鴻潟若障ゃ潟帥с若鴻<純絎茖<純潟若翫罕с@throws ャ<潟若激с潟膓帥{@inheritDoc} 篏睡с障 |
2411 自動的に追加されます。 |
3001 .LP |
2412 .LP |
3002 .LP |
2413 オーバーライドされたメソッドで明示的に例外が宣言されている場合に限って、 |
3003 荅括完ゃ |
2414 オーバーライドされたメソッドからサブクラスへ |
|
2415 @throws ドキュメントがコピーされます。 |
|
2416 インタフェースメソッドから実装メソッドにコピーされる場合も |
|
2417 同様です。{@inheritDoc} を使用して、継承ドキュメントに対して |
|
2418 強制的に @throws を適用することも可能です。 |
|
2419 .LP |
|
2420 詳細は |
|
2421 .fi |
|
2422 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@exception |
|
2423 の |
|
2424 .na |
3004 .na |
2425 \f2@throws タグのドキュメント\fPを参照してください。 |
3005 \f2@throws 帥違ャ<潟\fP @ |
2426 .TP |
3006 .fi |
2427 .B {@value package.class#field} |
3007 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@exceptionс |
2428 {@value} が静的フィールドの doc コメントで |
3008 .LP |
2429 引数なしで使用されている場合、その定数の値が表示されます。 |
3009 .LP |
2430 .LP |
3010 |
2431 .RS 5 |
3011 .LP |
2432 .nf |
3012 .RE |
2433 /** |
3013 .RS 3 |
2434 * The value of this constant is {@value}. |
3014 .TP 3 |
2435 */ |
3015 {@value\ package.class#field} |
2436 public static final String SCRIPT_START = "<script>" |
3016 \f2{@value}\fP c若 doc 潟<潟 綣違т戎翫絎違ゃ茵腓冴障 |
2437 .fi |
3017 .RE |
2438 .RE |
3018 |
2439 .LP |
3019 .LP |
2440 任意の doc コメント内で引数 |
3020 .RS 3 |
2441 .B package.class#field |
3021 |
2442 ありで使用されている場合は、指定した定数の値が表示されます。 |
3022 .LP |
2443 .LP |
3023 .nf |
2444 .RS 5 |
3024 \f3 |
2445 .nf |
3025 .fl |
2446 /** |
3026 /** |
2447 * Evaluates the script starting with {@value #SCRIPT_START}. |
3027 .fl |
2448 */ |
3028 * The value of this constant is {@value}. |
2449 public String evalScript(String script) { |
3029 .fl |
2450 } |
3030 */ |
2451 .fi |
3031 .fl |
2452 .RE |
3032 public static final String SCRIPT_START = "<script>" |
2453 .LP |
3033 .fl |
2454 引数 package.class#field は、@see 引数と同一の形式になります。 |
3034 |
2455 ただし、メンバが静的フィールドになければならない点が異なります。 |
3035 .fl |
2456 .LP |
3036 \fP |
2457 これらの定数での値は、「定数フィールド値」ページにも表示されます。 |
3037 .fi |
2458 .TP |
3038 |
2459 .BI @version " version-text" |
3039 .LP |
2460 \-version オプションが使われている場合、生成ドキュメントに「バージョン」小見出しを追加して、指定された \f2version\-text\fP を書き込みます。このタグは、このコードが含まれるソフトウェアの現在のバージョン番号を保持するように意図されています。これに対し、@since は、このコードが導入されたバージョン番号を保持します。\f2version\-text\fP には、特別な内部構造はありません。バージョンタグを使用できる場所を調べるには、「タグを使用できる場所」を参照してください。 |
3040 .LP |
2461 .LP |
3041 篁紙 doc 潟<潟у \f2package.class#field\fP т戎翫絎絎違ゃ茵腓冴障 |
2462 1 つのドキュメンテーションコメントに複数の \f2@version\fP タグを含めることができます。必要に応じて、\f2@version\fP タグごとに 1 つのバージョン番号を指定することも、タグごとに複数のバージョン番号を指定することもできます。前者の場合は、Javadoc ツールによって、名前と名前の間にコンマ (\f2,\fP) とスペースが挿入されます。後者の場合は、テキスト全体が、解析されることなく、生成ドキュメントにそのままコピーされます。したがって、コンマではなく、各言語に対応した名前区切り文字を使う必要がある場合は、1 つのタグに複数の名前を指定できます。 |
3042 .LP |
2463 .LP |
3043 .nf |
2464 詳細については、 |
3044 \f3 |
2465 .fi |
3045 .fl |
2466 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@version |
3046 /** |
2467 の |
3047 .fl |
|
3048 * Evaluates the script starting with {@value #SCRIPT_START}. |
|
3049 .fl |
|
3050 */ |
|
3051 .fl |
|
3052 public String evalScript(String script) { |
|
3053 .fl |
|
3054 } |
|
3055 .fl |
|
3056 |
|
3057 .fl |
|
3058 \fP |
|
3059 .fi |
|
3060 |
|
3061 .LP |
|
3062 .LP |
|
3063 綣 \f2package.class#field\fP @see 綣違筝綵√障<潟若c若違鴻違障 |
|
3064 .LP |
|
3065 .LP |
|
3066 絎違сゃ |
2468 .na |
3067 .na |
2469 \f2@version タグのドキュメント\fPを参照してください。 |
3068 \f2絎違c若\fP @ |
2470 .SS "タグを使用できる場所" |
3069 .fi |
2471 以下では、タグを使用できる場所について説明します。@see、@since、@deprecated、{@link}、{@linkplain} および {@docroot} のタグは、すべての doc コメントで使用できます。 |
3070 http://java.sun.com/javase/6/docs/api/constant\-values.html若吾茵腓冴障 |
2472 .SS "概要ドキュメントタグ" |
3071 .LP |
2473 概要タグは、概要ページのドキュメント |
3072 .LP |
2474 コメント (通常は \f3overview.html\f1 |
3073 |
2475 という名前のソースファイル内にある) で使用できるタグです。 |
3074 .LP |
2476 ほかのドキュメント |
3075 .RE |
2477 コメントと同様に、これらのタグは、説明のあとで使う必要があります。 |
3076 .RS 3 |
2478 .LP |
3077 .TP 3 |
2479 注:バージョン 1.2 では、概要ドキュメント内の {\f3@link\f1} タグに |
3078 @version\ version\-text |
2480 バグがあります。テキストは適切に表示されますが、 |
3079 \-version 激с潟篏帥翫ャ<潟 [若吾с] 絨頳冴菴遵絎 \f2version\-text\fP 吾莨若帥障帥違潟若障純с≪憜若吾с括垩篆潟障 絲障@since 潟若絨ャ若吾с括垩篆障\f2version\-text\fP 劫ャ罕障若吾с潟帥違篏睡с贋茯帥鴻帥違篏睡с贋с |
2481 リンクが設定されません。 |
3080 .RE |
2482 現在のところ、{\f2@docRoot\f1} タグは、 |
3081 |
2483 概要ドキュメント内では動作しません。 |
3082 .LP |
|
3083 .RS 3 |
|
3084 |
|
3085 .LP |
|
3086 .LP |
|
3087 1 ゃャ<潟若激с潟潟<潟茲違 \f2@version\fP 帥違с障綽荀綽\f2@version\fP 帥違 1 ゃ若吾с括垩絎帥違茲違若吾с括垩絎с障翫Javadoc 若c潟潟 (\f2,\fP) 鴻若鴻水ャ障緇翫鴻篏茹fャ<潟障障潟若障c潟潟с荐茯絲上阪絖篏帥綽荀1 ゃ帥違茲違絎 |
|
3088 .LP |
|
3089 .LP |
|
3090 荅括完ゃ |
|
3091 .na |
|
3092 \f2@version 帥違ャ<潟\fP @ |
|
3093 .fi |
|
3094 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@versionс |
|
3095 .LP |
|
3096 .RE |
|
3097 .LP |
|
3098 .SS |
|
3099 帥違篏睡с贋 |
|
3100 .LP |
|
3101 с帥違篏睡с贋ゃ茯障\f2@see\fP\f2@since\fP\f2@deprecated\fP\f2{@link}\fP\f2{@linkplain}\fP \f2{@docroot}\fP 帥違鴻 doc 潟<潟т戎с障 |
|
3102 .RS 3 |
|
3103 |
|
3104 .LP |
|
3105 .SS |
|
3106 网荀ャ<潟若激с潟帥 |
|
3107 .LP |
|
3108 .LP |
|
3109 网荀帥違网荀若吾ャ<潟若激с潟潟<潟т戎с帥違с ャ<潟若激с潟潟<潟絽 \f2overview.html\fP 純若鴻<ゃ障祉ャ<潟若激с潟潟<潟翫罕帥違筝肢т戎綽荀障 |
|
3110 .LP |
|
3111 .LP |
|
3112 \f3羈\fP \- 若吾с 1.2 с网荀ャ<潟 \f2{@link}\fP 帥違違障鴻罩c頫腓冴障潟荐絎障憜\f2{@docRoot}\fP 帥違网荀ャ<潟с篏障 |
|
3113 .LP |
|
3114 .RS 3 |
|
3115 |
2484 .LP |
3116 .LP |
2485 .LP |
3117 .LP |
2486 .TS |
3118 .TS |
2487 ; |
3119 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2488 cbp-1 |
3120 .de 35 |
2489 l . |
3121 .ps \n(.s |
2490 概要タグ |
3122 .vs \n(.vu |
2491 @see |
3123 .in \n(.iu |
2492 @since |
3124 .if \n(.u .fi |
2493 @author |
3125 .if \n(.j .ad |
2494 @version |
3126 .if \n(.j=0 .na |
2495 {@link} |
3127 .. |
2496 {@linkplain} |
3128 .nf |
2497 {@docRoot} |
3129 .nr #~ 0 |
|
3130 .if n .nr #~ 0.6n |
|
3131 .ds #d .d |
|
3132 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3133 .fc |
|
3134 .nr 33 \n(.s |
|
3135 .rm 80 |
|
3136 .nr 34 \n(.lu |
|
3137 .eo |
|
3138 .am 80 |
|
3139 .br |
|
3140 .di a+ |
|
3141 .35 |
|
3142 .ft \n(.f |
|
3143 .ll \n(34u*1u/2u |
|
3144 .if \n(.l<\n(80 .ll \n(80u |
|
3145 .in 0 |
|
3146 \f2@see\fP |
|
3147 .br |
|
3148 \f2@since\fP |
|
3149 .br |
|
3150 \f2@author\fP |
|
3151 .br |
|
3152 \f2@version\fP |
|
3153 .br |
|
3154 \f2{@link}\fP |
|
3155 .br |
|
3156 \f2{@linkplain}\fP |
|
3157 .br |
|
3158 \f2{@docRoot}\fP |
|
3159 .br |
|
3160 .di |
|
3161 .nr a| \n(dn |
|
3162 .nr a- \n(dl |
|
3163 .. |
|
3164 .ec \ |
|
3165 .35 |
|
3166 .nf |
|
3167 .ll \n(34u |
|
3168 .nr 80 0 |
|
3169 .nr 38 \w\f3网荀帥\fP |
|
3170 .if \n(80<\n(38 .nr 80 \n(38 |
|
3171 .80 |
|
3172 .rm 80 |
|
3173 .nr 38 \n(a- |
|
3174 .if \n(80<\n(38 .nr 80 \n(38 |
|
3175 .35 |
|
3176 .nf |
|
3177 .ll \n(34u |
|
3178 .nr 38 1n |
|
3179 .nr 79 0 |
|
3180 .nr 40 \n(79+(0*\n(38) |
|
3181 .nr 80 +\n(40 |
|
3182 .nr TW \n(80 |
|
3183 .if t .if \n(TW>\n(.li .tm Table at line 2280 file Input is too wide - \n(TW units |
|
3184 .fc |
|
3185 .nr #T 0-1 |
|
3186 .nr #a 0-1 |
|
3187 .eo |
|
3188 .de T# |
|
3189 .ds #d .d |
|
3190 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3191 .mk ## |
|
3192 .nr ## -1v |
|
3193 .ls 1 |
|
3194 .ls |
|
3195 .. |
|
3196 .ec |
|
3197 .ta \n(80u |
|
3198 .nr 31 \n(.f |
|
3199 .nr 35 1m |
|
3200 \&\h'|\n(40u'\f3网荀帥\fP |
|
3201 .ne \n(a|u+\n(.Vu |
|
3202 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
3203 .ta \n(80u |
|
3204 .nr 31 \n(.f |
|
3205 .nr 35 1m |
|
3206 \&\h'|\n(40u' |
|
3207 .mk ## |
|
3208 .nr 31 \n(## |
|
3209 .sp |\n(##u-1v |
|
3210 .nr 37 \n(40u |
|
3211 .in +\n(37u |
|
3212 .a+ |
|
3213 .in -\n(37u |
|
3214 .mk 32 |
|
3215 .if \n(32>\n(31 .nr 31 \n(32 |
|
3216 .sp |\n(31u |
|
3217 .fc |
|
3218 .nr T. 1 |
|
3219 .T# 1 |
|
3220 .35 |
|
3221 .rm a+ |
2498 .TE |
3222 .TE |
2499 .if \n-(b.=0 .nr c. \n(.c-\n(d.-20 |
3223 .if \n-(b.=0 .nr c. \n(.c-\n(d.-20 |
2500 |
3224 |
2501 .LP |
3225 .LP |
2502 .SS "パッケージドキュメントタグ" |
3226 .RE |
2503 パッケージタグは、パッケージのドキュメント |
3227 .SS |
2504 コメント (\f3package.html\f1 または \f2package\-info.java\fP という |
3228 宴若吾ャ<潟若激с潟帥 |
2505 名前のソースファイルに存在) で使用できるタグです。 |
3229 .LP |
2506 ここで使用できる @serial タグは、include または |
3230 .LP |
2507 exclude 引数を指定したものだけです。 |
3231 宴若吾帥違宴若吾ャ<潟若激с潟潟<潟т戎с帥違с ャ<潟若激с潟潟<潟\f2package.html\fP 障 \f2package\-info.java\fP 純若鴻<ゃ障т戎с \f2@serial\fP 帥違\f2include\fP 障 \f2exclude\fP 綣違絎с |
|
3232 .LP |
|
3233 .RS 3 |
|
3234 |
2508 .LP |
3235 .LP |
2509 .LP |
3236 .LP |
2510 .TS |
3237 .TS |
2511 ; |
3238 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2512 cbp-1 |
3239 .de 35 |
2513 l . |
3240 .ps \n(.s |
2514 パッケージタグ |
3241 .vs \n(.vu |
2515 @see |
3242 .in \n(.iu |
2516 @since |
3243 .if \n(.u .fi |
2517 @serial |
3244 .if \n(.j .ad |
2518 @author |
3245 .if \n(.j=0 .na |
2519 @version |
3246 .. |
2520 {@link} |
3247 .nf |
2521 {@linkplain} |
3248 .nr #~ 0 |
2522 {@docRoot} |
3249 .if n .nr #~ 0.6n |
|
3250 .ds #d .d |
|
3251 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3252 .fc |
|
3253 .nr 33 \n(.s |
|
3254 .rm 80 |
|
3255 .nr 34 \n(.lu |
|
3256 .eo |
|
3257 .am 80 |
|
3258 .br |
|
3259 .di a+ |
|
3260 .35 |
|
3261 .ft \n(.f |
|
3262 .ll \n(34u*1u/2u |
|
3263 .if \n(.l<\n(80 .ll \n(80u |
|
3264 .in 0 |
|
3265 \f2@see\fP |
|
3266 .br |
|
3267 \f2@since\fP |
|
3268 .br |
|
3269 \f2@serial\fP |
|
3270 .br |
|
3271 \f2@author\fP |
|
3272 .br |
|
3273 \f2@version\fP |
|
3274 .br |
|
3275 \f2{@link}\fP |
|
3276 .br |
|
3277 \f2{@linkplain}\fP |
|
3278 .br |
|
3279 \f2{@docRoot}\fP |
|
3280 .br |
|
3281 .di |
|
3282 .nr a| \n(dn |
|
3283 .nr a- \n(dl |
|
3284 .. |
|
3285 .ec \ |
|
3286 .35 |
|
3287 .nf |
|
3288 .ll \n(34u |
|
3289 .nr 80 0 |
|
3290 .nr 38 \w\f3宴若吾帥\fP |
|
3291 .if \n(80<\n(38 .nr 80 \n(38 |
|
3292 .80 |
|
3293 .rm 80 |
|
3294 .nr 38 \n(a- |
|
3295 .if \n(80<\n(38 .nr 80 \n(38 |
|
3296 .35 |
|
3297 .nf |
|
3298 .ll \n(34u |
|
3299 .nr 38 1n |
|
3300 .nr 79 0 |
|
3301 .nr 40 \n(79+(0*\n(38) |
|
3302 .nr 80 +\n(40 |
|
3303 .nr TW \n(80 |
|
3304 .if t .if \n(TW>\n(.li .tm Table at line 2316 file Input is too wide - \n(TW units |
|
3305 .fc |
|
3306 .nr #T 0-1 |
|
3307 .nr #a 0-1 |
|
3308 .eo |
|
3309 .de T# |
|
3310 .ds #d .d |
|
3311 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3312 .mk ## |
|
3313 .nr ## -1v |
|
3314 .ls 1 |
|
3315 .ls |
|
3316 .. |
|
3317 .ec |
|
3318 .ta \n(80u |
|
3319 .nr 31 \n(.f |
|
3320 .nr 35 1m |
|
3321 \&\h'|\n(40u'\f3宴若吾帥\fP |
|
3322 .ne \n(a|u+\n(.Vu |
|
3323 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
3324 .ta \n(80u |
|
3325 .nr 31 \n(.f |
|
3326 .nr 35 1m |
|
3327 \&\h'|\n(40u' |
|
3328 .mk ## |
|
3329 .nr 31 \n(## |
|
3330 .sp |\n(##u-1v |
|
3331 .nr 37 \n(40u |
|
3332 .in +\n(37u |
|
3333 .a+ |
|
3334 .in -\n(37u |
|
3335 .mk 32 |
|
3336 .if \n(32>\n(31 .nr 31 \n(32 |
|
3337 .sp |\n(31u |
|
3338 .fc |
|
3339 .nr T. 1 |
|
3340 .T# 1 |
|
3341 .35 |
|
3342 .rm a+ |
2523 .TE |
3343 .TE |
2524 .if \n-(b.=0 .nr c. \n(.c-\n(d.-22 |
3344 .if \n-(b.=0 .nr c. \n(.c-\n(d.-22 |
2525 |
3345 |
2526 .LP |
3346 .LP |
2527 .SS "クラスおよびインタフェースドキュメントタグ" |
3347 .RE |
2528 次に示すのは、クラスまたはインタフェースのドキュメント |
3348 .SS |
2529 コメントで使用できるタグです。 |
3349 鴻潟ゃ潟帥с若鴻ャ<潟若激с潟帥 |
2530 ここで使用できる @serial タグは、 |
3350 .LP |
2531 include または exclude 引数を指定したものだけです。 |
3351 .LP |
|
3352 罨<鴻障ゃ潟帥с若鴻ャ<潟若激с潟潟<潟т戎с帥違腓冴障т戎с \f2@serial\fP 帥違\f2include\fP 障 \f2exclude\fP 綣違絎с |
|
3353 .LP |
|
3354 .RS 3 |
|
3355 |
2532 .LP |
3356 .LP |
2533 .LP |
3357 .LP |
2534 .TS |
3358 .TS |
2535 ; |
3359 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2536 cbp-1 |
3360 .de 35 |
2537 l . |
3361 .ps \n(.s |
2538 クラスおよびインタフェースタグ |
3362 .vs \n(.vu |
2539 @see |
3363 .in \n(.iu |
2540 @since |
3364 .if \n(.u .fi |
2541 @deprecated |
3365 .if \n(.j .ad |
2542 @serial |
3366 .if \n(.j=0 .na |
2543 @author |
3367 .. |
2544 @version |
3368 .nf |
2545 {@link} |
3369 .nr #~ 0 |
2546 {@linkplain} |
3370 .if n .nr #~ 0.6n |
2547 {@docRoot} |
3371 .ds #d .d |
|
3372 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3373 .fc |
|
3374 .nr 33 \n(.s |
|
3375 .rm 80 |
|
3376 .nr 34 \n(.lu |
|
3377 .eo |
|
3378 .am 80 |
|
3379 .br |
|
3380 .di a+ |
|
3381 .35 |
|
3382 .ft \n(.f |
|
3383 .ll \n(34u*1u/2u |
|
3384 .if \n(.l<\n(80 .ll \n(80u |
|
3385 .in 0 |
|
3386 \f3鴻潟ゃ潟帥с若鴻帥\fP |
|
3387 .br |
|
3388 .di |
|
3389 .nr a| \n(dn |
|
3390 .nr a- \n(dl |
|
3391 .. |
|
3392 .ec \ |
|
3393 .eo |
|
3394 .am 80 |
|
3395 .br |
|
3396 .di b+ |
|
3397 .35 |
|
3398 .ft \n(.f |
|
3399 .ll \n(34u*1u/2u |
|
3400 .if \n(.l<\n(80 .ll \n(80u |
|
3401 .in 0 |
|
3402 \f2@see\fP |
|
3403 .br |
|
3404 \f2@since\fP |
|
3405 .br |
|
3406 \f2@deprecated\fP |
|
3407 .br |
|
3408 \f2@serial\fP |
|
3409 .br |
|
3410 \f2@author\fP |
|
3411 .br |
|
3412 \f2@version\fP |
|
3413 .br |
|
3414 \f2{@link}\fP |
|
3415 .br |
|
3416 \f2{@linkplain}\fP |
|
3417 .br |
|
3418 \f2{@docRoot}\fP |
|
3419 .br |
|
3420 .di |
|
3421 .nr b| \n(dn |
|
3422 .nr b- \n(dl |
|
3423 .. |
|
3424 .ec \ |
|
3425 .35 |
|
3426 .nf |
|
3427 .ll \n(34u |
|
3428 .nr 80 0 |
|
3429 .80 |
|
3430 .rm 80 |
|
3431 .nr 38 \n(a- |
|
3432 .if \n(80<\n(38 .nr 80 \n(38 |
|
3433 .nr 38 \n(b- |
|
3434 .if \n(80<\n(38 .nr 80 \n(38 |
|
3435 .35 |
|
3436 .nf |
|
3437 .ll \n(34u |
|
3438 .nr 38 1n |
|
3439 .nr 79 0 |
|
3440 .nr 40 \n(79+(0*\n(38) |
|
3441 .nr 80 +\n(40 |
|
3442 .nr TW \n(80 |
|
3443 .if t .if \n(TW>\n(.li .tm Table at line 2356 file Input is too wide - \n(TW units |
|
3444 .fc |
|
3445 .nr #T 0-1 |
|
3446 .nr #a 0-1 |
|
3447 .eo |
|
3448 .de T# |
|
3449 .ds #d .d |
|
3450 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3451 .mk ## |
|
3452 .nr ## -1v |
|
3453 .ls 1 |
|
3454 .ls |
|
3455 .. |
|
3456 .ec |
|
3457 .ne \n(a|u+\n(.Vu |
|
3458 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
3459 .ta \n(80u |
|
3460 .nr 31 \n(.f |
|
3461 .nr 35 1m |
|
3462 \&\h'|\n(40u' |
|
3463 .mk ## |
|
3464 .nr 31 \n(## |
|
3465 .sp |\n(##u-1v |
|
3466 .nr 37 \n(40u |
|
3467 .in +\n(37u |
|
3468 .a+ |
|
3469 .in -\n(37u |
|
3470 .mk 32 |
|
3471 .if \n(32>\n(31 .nr 31 \n(32 |
|
3472 .sp |\n(31u |
|
3473 .ne \n(b|u+\n(.Vu |
|
3474 .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) |
|
3475 .ta \n(80u |
|
3476 .nr 31 \n(.f |
|
3477 .nr 35 1m |
|
3478 \&\h'|\n(40u' |
|
3479 .mk ## |
|
3480 .nr 31 \n(## |
|
3481 .sp |\n(##u-1v |
|
3482 .nr 37 \n(40u |
|
3483 .in +\n(37u |
|
3484 .b+ |
|
3485 .in -\n(37u |
|
3486 .mk 32 |
|
3487 .if \n(32>\n(31 .nr 31 \n(32 |
|
3488 .sp |\n(31u |
|
3489 .fc |
|
3490 .nr T. 1 |
|
3491 .T# 1 |
|
3492 .35 |
|
3493 .rm a+ |
|
3494 .rm b+ |
2548 .TE |
3495 .TE |
2549 |
3496 .if \n-(b.=0 .nr c. \n(.c-\n(d.-26 |
2550 .LP |
3497 |
2551 次は、クラスコメントの例です。 |
3498 .LP |
2552 .LP |
3499 .RE |
2553 .RS |
3500 \f3罨<鴻潟<潟箴腓冴障\fP |
2554 .ft 3 |
3501 .LP |
2555 .nf |
3502 .nf |
|
3503 \f3 |
|
3504 .fl |
2556 /** |
3505 /** |
2557 * A class representing a window on the screen. |
3506 .fl |
2558 * For example: |
3507 * A class representing a window on the screen. |
2559 * <pre> |
3508 .fl |
2560 * Window win = new Window(parent); |
3509 * For example: |
2561 * win.show(); |
3510 .fl |
2562 * </pre> |
3511 * <pre> |
2563 * |
3512 .fl |
2564 * @author Sami Shaio |
3513 * Window win = new Window(parent); |
2565 * @version 1.13, 06/08/06 |
3514 .fl |
2566 * @see java.awt.BaseWindow |
3515 * win.show(); |
2567 * @see java.awt.Button |
3516 .fl |
2568 */ |
3517 * </pre> |
|
3518 .fl |
|
3519 * |
|
3520 .fl |
|
3521 * @author Sami Shaio |
|
3522 .fl |
|
3523 * @version 1.13, 06/08/06 |
|
3524 .fl |
|
3525 * @see java.awt.BaseWindow |
|
3526 .fl |
|
3527 * @see java.awt.Button |
|
3528 .fl |
|
3529 */ |
|
3530 .fl |
2569 class Window extends BaseWindow { |
3531 class Window extends BaseWindow { |
2570 ... |
3532 .fl |
|
3533 ... |
|
3534 .fl |
2571 } |
3535 } |
2572 .fi |
3536 .fl |
2573 .ft 1 |
3537 |
2574 .RE |
3538 .fl |
2575 .SS "フィールドドキュメントタグ" |
3539 \fP |
2576 次に示すのは、フィールドのドキュメンテーションコメントで |
3540 .fi |
2577 使用できるタグです。 |
3541 |
|
3542 .LP |
|
3543 .SS |
|
3544 c若ャ<潟若激с潟帥 |
|
3545 .LP |
|
3546 .LP |
|
3547 罨<c若ャ<潟若激с潟潟<潟т戎с帥違腓冴障 |
|
3548 .LP |
|
3549 .RS 3 |
|
3550 |
2578 .LP |
3551 .LP |
2579 .LP |
3552 .LP |
2580 .TS |
3553 .TS |
2581 ; |
3554 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2582 cbp-1 |
3555 .de 35 |
2583 l . |
3556 .ps \n(.s |
2584 フィールドタグ |
3557 .vs \n(.vu |
2585 @see |
3558 .in \n(.iu |
2586 @since |
3559 .if \n(.u .fi |
2587 @deprecated |
3560 .if \n(.j .ad |
2588 @serial |
3561 .if \n(.j=0 .na |
2589 @serialField |
3562 .. |
2590 {@link} |
3563 .nf |
2591 {@linkplain} |
3564 .nr #~ 0 |
2592 {@docRoot} |
3565 .if n .nr #~ 0.6n |
2593 {@value} |
3566 .ds #d .d |
|
3567 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3568 .fc |
|
3569 .nr 33 \n(.s |
|
3570 .rm 80 |
|
3571 .nr 34 \n(.lu |
|
3572 .eo |
|
3573 .am 80 |
|
3574 .br |
|
3575 .di a+ |
|
3576 .35 |
|
3577 .ft \n(.f |
|
3578 .ll \n(34u*1u/2u |
|
3579 .if \n(.l<\n(80 .ll \n(80u |
|
3580 .in 0 |
|
3581 \f2@see\fP |
|
3582 .br |
|
3583 \f2@since\fP |
|
3584 .br |
|
3585 \f2@deprecated\fP |
|
3586 .br |
|
3587 \f2@serial\fP |
|
3588 .br |
|
3589 \f2@serialField\fP |
|
3590 .br |
|
3591 \f2{@link}\fP |
|
3592 .br |
|
3593 \f2{@linkplain}\fP |
|
3594 .br |
|
3595 \f2{@docRoot}\fP |
|
3596 .br |
|
3597 \f2{@value}\fP |
|
3598 .br |
|
3599 .di |
|
3600 .nr a| \n(dn |
|
3601 .nr a- \n(dl |
|
3602 .. |
|
3603 .ec \ |
|
3604 .35 |
|
3605 .nf |
|
3606 .ll \n(34u |
|
3607 .nr 80 0 |
|
3608 .nr 38 \w\f3c若帥\fP |
|
3609 .if \n(80<\n(38 .nr 80 \n(38 |
|
3610 .80 |
|
3611 .rm 80 |
|
3612 .nr 38 \n(a- |
|
3613 .if \n(80<\n(38 .nr 80 \n(38 |
|
3614 .35 |
|
3615 .nf |
|
3616 .ll \n(34u |
|
3617 .nr 38 1n |
|
3618 .nr 79 0 |
|
3619 .nr 40 \n(79+(0*\n(38) |
|
3620 .nr 80 +\n(40 |
|
3621 .nr TW \n(80 |
|
3622 .if t .if \n(TW>\n(.li .tm Table at line 2437 file Input is too wide - \n(TW units |
|
3623 .fc |
|
3624 .nr #T 0-1 |
|
3625 .nr #a 0-1 |
|
3626 .eo |
|
3627 .de T# |
|
3628 .ds #d .d |
|
3629 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3630 .mk ## |
|
3631 .nr ## -1v |
|
3632 .ls 1 |
|
3633 .ls |
|
3634 .. |
|
3635 .ec |
|
3636 .ta \n(80u |
|
3637 .nr 31 \n(.f |
|
3638 .nr 35 1m |
|
3639 \&\h'|\n(40u'\f3c若帥\fP |
|
3640 .ne \n(a|u+\n(.Vu |
|
3641 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
3642 .ta \n(80u |
|
3643 .nr 31 \n(.f |
|
3644 .nr 35 1m |
|
3645 \&\h'|\n(40u' |
|
3646 .mk ## |
|
3647 .nr 31 \n(## |
|
3648 .sp |\n(##u-1v |
|
3649 .nr 37 \n(40u |
|
3650 .in +\n(37u |
|
3651 .a+ |
|
3652 .in -\n(37u |
|
3653 .mk 32 |
|
3654 .if \n(32>\n(31 .nr 31 \n(32 |
|
3655 .sp |\n(31u |
|
3656 .fc |
|
3657 .nr T. 1 |
|
3658 .T# 1 |
|
3659 .35 |
|
3660 .rm a+ |
2594 .TE |
3661 .TE |
2595 .if \n-(b.=0 .nr c. \n(.c-\n(d.-24 |
3662 .if \n-(b.=0 .nr c. \n(.c-\n(d.-24 |
2596 |
3663 |
2597 .LP |
3664 .LP |
2598 次は、フィールドコメントの例です。 |
3665 .RE |
2599 .LP |
3666 \f3罨<c若潟<潟箴腓冴障\fP |
2600 .RS |
3667 .LP |
2601 .ft 3 |
3668 .nf |
2602 .nf |
3669 \f3 |
2603 /** |
3670 .fl |
2604 * The X-coordinate of the component. |
3671 /** |
2605 * |
3672 .fl |
2606 * @see #getLocation() |
3673 * The X\-coordinate of the component. |
2607 */ |
3674 .fl |
2608 int x = 1263732; |
3675 * |
2609 .fi |
3676 .fl |
2610 .ft 1 |
3677 * @see #getLocation() |
2611 .RE |
3678 .fl |
2612 .SS "コンストラクタおよびメソッドドキュメントタグ" |
3679 */ |
2613 次に、コンストラクタまたはメソッドのドキュメンテーションコメント内で表示できるタグを示します。ただし、@return はコンストラクタでは表示できず、{@inheritDoc} は |
3680 .fl |
2614 表示に制限があります。@serialData タグは特定の直列化メソッドの doc コメントでのみ使用できます。 |
3681 int x = 1263732; |
|
3682 .fl |
|
3683 |
|
3684 .fl |
|
3685 \fP |
|
3686 .fi |
|
3687 |
|
3688 .LP |
|
3689 .SS |
|
3690 潟潟鴻帥潟<純ャ<潟若激с潟帥 |
|
3691 .LP |
|
3692 .LP |
|
3693 罨<潟潟鴻帥障<純ャ<潟若激с潟潟<潟ц;腓冴с帥違腓冴障 \f2@return\fP 潟潟鴻帥с茵腓冴с\f2{@inheritDoc}\fP 茵腓冴狗障\f2@serialData\fP 帥違劫翫<純 doc 潟<潟с推戎с障 |
|
3694 .LP |
|
3695 .RS 3 |
|
3696 |
2615 .LP |
3697 .LP |
2616 .LP |
3698 .LP |
2617 .TS |
3699 .TS |
2618 ; |
3700 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2619 cbp-1 |
3701 .de 35 |
2620 l . |
3702 .ps \n(.s |
2621 メソッドおよびコンストラクタタグ |
3703 .vs \n(.vu |
2622 @see |
3704 .in \n(.iu |
2623 @since |
3705 .if \n(.u .fi |
2624 @deprecated |
3706 .if \n(.j .ad |
2625 @param |
3707 .if \n(.j=0 .na |
2626 @return |
3708 .. |
2627 @throws and @exception |
3709 .nf |
2628 @serialData |
3710 .nr #~ 0 |
2629 {@link} |
3711 .if n .nr #~ 0.6n |
2630 {@linkplain} |
3712 .ds #d .d |
2631 {@inheritDoc} |
3713 .if \(ts\n(.z\(ts\(ts .ds #d nl |
2632 {@docRoot} |
3714 .fc |
|
3715 .nr 33 \n(.s |
|
3716 .rm 80 |
|
3717 .nr 34 \n(.lu |
|
3718 .eo |
|
3719 .am 80 |
|
3720 .br |
|
3721 .di a+ |
|
3722 .35 |
|
3723 .ft \n(.f |
|
3724 .ll \n(34u*1u/2u |
|
3725 .if \n(.l<\n(80 .ll \n(80u |
|
3726 .in 0 |
|
3727 \f3<純潟潟潟鴻帥帥\fP |
|
3728 .br |
|
3729 .di |
|
3730 .nr a| \n(dn |
|
3731 .nr a- \n(dl |
|
3732 .. |
|
3733 .ec \ |
|
3734 .eo |
|
3735 .am 80 |
|
3736 .br |
|
3737 .di b+ |
|
3738 .35 |
|
3739 .ft \n(.f |
|
3740 .ll \n(34u*1u/2u |
|
3741 .if \n(.l<\n(80 .ll \n(80u |
|
3742 .in 0 |
|
3743 \f2@see\fP |
|
3744 .br |
|
3745 \f2@since\fP |
|
3746 .br |
|
3747 \f2@deprecated\fP |
|
3748 .br |
|
3749 \f2@param\fP |
|
3750 .br |
|
3751 \f2@return\fP |
|
3752 .br |
|
3753 \f2@throws\fP \f2@exception\fP |
|
3754 .br |
|
3755 \f2@serialData\fP |
|
3756 .br |
|
3757 \f2{@link}\fP |
|
3758 .br |
|
3759 \f2{@linkplain}\fP |
|
3760 .br |
|
3761 \f2{@inheritDoc}\fP |
|
3762 .br |
|
3763 \f2{@docRoot}\fP |
|
3764 .br |
|
3765 .di |
|
3766 .nr b| \n(dn |
|
3767 .nr b- \n(dl |
|
3768 .. |
|
3769 .ec \ |
|
3770 .35 |
|
3771 .nf |
|
3772 .ll \n(34u |
|
3773 .nr 80 0 |
|
3774 .80 |
|
3775 .rm 80 |
|
3776 .nr 38 \n(a- |
|
3777 .if \n(80<\n(38 .nr 80 \n(38 |
|
3778 .nr 38 \n(b- |
|
3779 .if \n(80<\n(38 .nr 80 \n(38 |
|
3780 .35 |
|
3781 .nf |
|
3782 .ll \n(34u |
|
3783 .nr 38 1n |
|
3784 .nr 79 0 |
|
3785 .nr 40 \n(79+(0*\n(38) |
|
3786 .nr 80 +\n(40 |
|
3787 .nr TW \n(80 |
|
3788 .if t .if \n(TW>\n(.li .tm Table at line 2504 file Input is too wide - \n(TW units |
|
3789 .fc |
|
3790 .nr #T 0-1 |
|
3791 .nr #a 0-1 |
|
3792 .eo |
|
3793 .de T# |
|
3794 .ds #d .d |
|
3795 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
3796 .mk ## |
|
3797 .nr ## -1v |
|
3798 .ls 1 |
|
3799 .ls |
|
3800 .. |
|
3801 .ec |
|
3802 .ne \n(a|u+\n(.Vu |
|
3803 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
3804 .ta \n(80u |
|
3805 .nr 31 \n(.f |
|
3806 .nr 35 1m |
|
3807 \&\h'|\n(40u' |
|
3808 .mk ## |
|
3809 .nr 31 \n(## |
|
3810 .sp |\n(##u-1v |
|
3811 .nr 37 \n(40u |
|
3812 .in +\n(37u |
|
3813 .a+ |
|
3814 .in -\n(37u |
|
3815 .mk 32 |
|
3816 .if \n(32>\n(31 .nr 31 \n(32 |
|
3817 .sp |\n(31u |
|
3818 .ne \n(b|u+\n(.Vu |
|
3819 .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) |
|
3820 .ta \n(80u |
|
3821 .nr 31 \n(.f |
|
3822 .nr 35 1m |
|
3823 \&\h'|\n(40u' |
|
3824 .mk ## |
|
3825 .nr 31 \n(## |
|
3826 .sp |\n(##u-1v |
|
3827 .nr 37 \n(40u |
|
3828 .in +\n(37u |
|
3829 .b+ |
|
3830 .in -\n(37u |
|
3831 .mk 32 |
|
3832 .if \n(32>\n(31 .nr 31 \n(32 |
|
3833 .sp |\n(31u |
|
3834 .fc |
|
3835 .nr T. 1 |
|
3836 .T# 1 |
|
3837 .35 |
|
3838 .rm a+ |
|
3839 .rm b+ |
2633 .TE |
3840 .TE |
2634 .if \n-(b.=0 .nr c. \n(.c-\n(d.-28 |
3841 .if \n-(b.=0 .nr c. \n(.c-\n(d.-30 |
2635 |
3842 |
2636 .LP |
3843 .LP |
2637 次はメソッドの doc コメントの例です。 |
3844 .RE |
2638 .LP |
3845 \f3罨<<純ャ<潟若激с潟潟<潟箴腓冴障\fP |
2639 .RS |
3846 .LP |
2640 .ft 3 |
3847 .nf |
2641 .nf |
3848 \f3 |
2642 /** |
3849 .fl |
2643 * Returns the character at the specified index. An index |
3850 /** |
2644 * ranges from <code>0</code> to <code>length() - 1</code>. |
3851 .fl |
2645 * |
3852 * Returns the character at the specified index. An index |
2646 * @param index the index of the desired character. |
3853 .fl |
2647 * @return the desired character. |
3854 * ranges from <code>0</code> to <code>length() \- 1</code>. |
2648 * @exception StringIndexOutOfRangeException |
3855 .fl |
2649 * if the index is not in the range <code>0</code> |
3856 * |
2650 * to <code>length()-1</code>. |
3857 .fl |
2651 * @see java.lang.Character#charValue() |
3858 * @param index the index of the desired character. |
2652 */ |
3859 .fl |
2653 public char charAt(int index) { |
3860 * @return the desired character. |
2654 ... |
3861 .fl |
2655 } |
3862 * @exception StringIndexOutOfRangeException |
2656 .fi |
3863 .fl |
2657 .ft 1 |
3864 * if the index is not in the range <code>0</code> |
2658 .RE |
3865 .fl |
2659 .SH "オプション" |
3866 * to <code>length()\-1</code>. |
2660 .B javadoc |
3867 .fl |
2661 ツールは、ドックレットを使って出力を決定します。 |
3868 * @see java.lang.Character#charValue() |
2662 .B javadoc |
3869 .fl |
2663 ツールは、 |
3870 */ |
2664 .B \-doclet |
3871 .fl |
2665 オプションでカスタムドックレットが指定されている場合以外は、 |
3872 public char charAt(int index) { |
2666 デフォルトの標準ドック |
3873 .fl |
2667 レットを使います。 |
3874 ... |
2668 .B javadoc |
3875 .fl |
2669 ツールには、任意のドックレットとともに使用できるコマンド行 |
3876 } |
2670 オプションがあります。これらのオプ |
3877 .fl |
2671 ションについては、後述の「javadoc のオプション」で説明します。 |
3878 |
2672 標準ドックレットでは、こ |
3879 .fl |
2673 のほかに、いくつかの追加のコマンド行オプションが提供されます。 |
3880 \fP |
2674 これらのオプションに |
3881 .fi |
2675 ついては、後述の「標準ドックレットが提供するオプション」で |
3882 .RE |
2676 説明します。どのオプション |
3883 .SH "激с" |
2677 名も大文字と小文字を区別しません。ただし、オプションの引数では |
3884 .LP |
2678 大文字と小文字が区 |
3885 .LP |
2679 別されることがあります。 |
3886 javadoc 若篏帥c阪羆阪障Javadoc 若\-doclet 激с潟с鴻帥絎翫篁ュ罔羣篏帥障Javadoc 若篁紙篏睡с潟潟茵激с潟障 激с潟ゃJavadoc 激с潟ц障罔羣с祉ゃ菴遵潟潟茵激с潟箴障 激с潟ゃ罔羣箴激с潟ц障激с喝紊ф絖絨絖阪ャ障 激с潟綣違с紊ф絖絨絖阪ャ障 |
2680 .LP |
3887 .LP |
2681 オプションを以下に示します。 |
3888 .LP |
|
3889 激с潟罨<腓冴障 |
2682 .LP |
3890 .LP |
2683 .RS 3 |
3891 .RS 3 |
2684 |
3892 |
2685 .LP |
3893 .LP |
2686 .LP |
3894 .LP |
2687 .TS |
3895 .TS |
2688 center; |
3896 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2689 li l li |
3897 .de 35 |
2690 l li li |
3898 .ps \n(.s |
2691 li l li |
3899 .vs \n(.vu |
2692 l li li |
3900 .in \n(.iu |
2693 li l l |
3901 .if \n(.u .fi |
2694 l l li |
3902 .if \n(.j .ad |
2695 li l li |
3903 .if \n(.j=0 .na |
2696 l l l |
3904 .. |
2697 l li l |
3905 .nf |
2698 l l li |
3906 .nr #~ 0 |
2699 li l l |
3907 .if n .nr #~ 0.6n |
2700 li l l |
3908 .ds #d .d |
2701 l l l |
3909 .if \(ts\n(.z\(ts\(ts .ds #d nl |
2702 li l l |
3910 .fc |
2703 li l l |
3911 .nr 33 \n(.s |
2704 l l li |
3912 .rm 80 81 82 |
2705 li l l |
3913 .nr 34 \n(.lu |
2706 l l l |
3914 .eo |
2707 l l l |
3915 .am 80 |
2708 l li l |
3916 .br |
2709 l li l. |
3917 .di a+ |
2710 -1.1 -header -private |
3918 .35 |
2711 -author -help -protected |
3919 .ft \n(.f |
2712 -bootclasspath -helpfile -public |
3920 .ll \n(34u*1u/4u |
2713 -bottom -J -quiet |
3921 .if \n(.l<\n(80 .ll \n(80u |
2714 -breakiterator -keywords -serialwarn |
3922 .in 0 |
2715 -charset -link -source |
3923 \-\f21.1\fP |
2716 -classpath -linkoffline -sourcepath |
3924 .br |
2717 -d -linksource -splitindex |
3925 \-author |
2718 -docencoding -locale -stylesheetfile |
3926 .br |
2719 -docfilessubdirs -nocomment -subpackages |
3927 \-\f2bootclasspath\fP |
2720 -doclet -nodeprecated -tag |
3928 .br |
2721 -docletpath -nodeprecatedlist -taglet |
3929 \-bottom |
2722 -doctitle -nohelp -tagletpath |
3930 .br |
2723 -encoding -noindex -title |
3931 \-\f2breakiterator\fP |
2724 -exclude -nonavbar -use |
3932 .br |
2725 -excludedocfilessubdir -noqualifier -verbose |
3933 \-charset |
2726 -extdirs -nosince -version |
3934 .br |
2727 -footer -notimestamp -windowtitle |
3935 \-\f2classpath\fP |
2728 -group -notree |
3936 .br |
2729 -overview |
3937 \-d |
2730 -package |
3938 .br |
|
3939 \-docencoding |
|
3940 .br |
|
3941 \-docfilessubdirs |
|
3942 .br |
|
3943 \-\f2doclet\fP |
|
3944 .br |
|
3945 \-\f2docletpath\fP |
|
3946 .br |
|
3947 \-doctitle |
|
3948 .br |
|
3949 \-\f2encoding\fP |
|
3950 .br |
|
3951 \-\f2exclude\fP |
|
3952 .br |
|
3953 \-excludedocfilessubdir |
|
3954 .br |
|
3955 \-\f2extdirs\fP |
|
3956 .br |
|
3957 \-footer |
|
3958 .br |
|
3959 \-group |
|
3960 .br |
|
3961 .br |
|
3962 .di |
|
3963 .nr a| \n(dn |
|
3964 .nr a- \n(dl |
|
3965 .. |
|
3966 .ec \ |
|
3967 .eo |
|
3968 .am 81 |
|
3969 .br |
|
3970 .di b+ |
|
3971 .35 |
|
3972 .ft \n(.f |
|
3973 .ll \n(34u*1u/4u |
|
3974 .if \n(.l<\n(81 .ll \n(81u |
|
3975 .in 0 |
|
3976 \-header |
|
3977 .br |
|
3978 \-\f2help\fP |
|
3979 .br |
|
3980 \-helpfile |
|
3981 .br |
|
3982 \-\f2J\fP |
|
3983 .br |
|
3984 \-keywords |
|
3985 .br |
|
3986 \-link |
|
3987 .br |
|
3988 \-linkoffline |
|
3989 .br |
|
3990 \-linksource |
|
3991 .br |
|
3992 \-\f2locale\fP |
|
3993 .br |
|
3994 \-nocomment |
|
3995 .br |
|
3996 \-nodeprecated |
|
3997 .br |
|
3998 \-nodeprecatedlist |
|
3999 .br |
|
4000 \-nohelp |
|
4001 .br |
|
4002 \-noindex |
|
4003 .br |
|
4004 \-nonavbar |
|
4005 .br |
|
4006 \-noqualifier |
|
4007 .br |
|
4008 \-nosince |
|
4009 .br |
|
4010 \-notimestamp |
|
4011 .br |
|
4012 \-notree |
|
4013 .br |
|
4014 \-\f2overview\fP |
|
4015 .br |
|
4016 \-\f2package\fP |
|
4017 .br |
|
4018 .br |
|
4019 .di |
|
4020 .nr b| \n(dn |
|
4021 .nr b- \n(dl |
|
4022 .. |
|
4023 .ec \ |
|
4024 .eo |
|
4025 .am 82 |
|
4026 .br |
|
4027 .di c+ |
|
4028 .35 |
|
4029 .ft \n(.f |
|
4030 .ll \n(34u*1u/4u |
|
4031 .if \n(.l<\n(82 .ll \n(82u |
|
4032 .in 0 |
|
4033 \-\f2private\fP |
|
4034 .br |
|
4035 \-\f2protected\fP |
|
4036 .br |
|
4037 \-\f2public\fP |
|
4038 .br |
|
4039 \-\f2quiet\fP |
|
4040 .br |
|
4041 \-serialwarn |
|
4042 .br |
|
4043 \-\f2source\fP |
|
4044 .br |
|
4045 \-\f2sourcepath\fP |
|
4046 .br |
|
4047 \-splitindex |
|
4048 .br |
|
4049 \-stylesheetfile |
|
4050 .br |
|
4051 \-\f2subpackages\fP |
|
4052 .br |
|
4053 \-tag |
|
4054 .br |
|
4055 \-taglet |
|
4056 .br |
|
4057 \-tagletpath |
|
4058 .br |
|
4059 \-title |
|
4060 .br |
|
4061 \-use |
|
4062 .br |
|
4063 \-\f2verbose\fP |
|
4064 .br |
|
4065 \-version |
|
4066 .br |
|
4067 \-windowtitle |
|
4068 .br |
|
4069 .br |
|
4070 .di |
|
4071 .nr c| \n(dn |
|
4072 .nr c- \n(dl |
|
4073 .. |
|
4074 .ec \ |
|
4075 .35 |
|
4076 .nf |
|
4077 .ll \n(34u |
|
4078 .nr 80 0 |
|
4079 .80 |
|
4080 .rm 80 |
|
4081 .nr 38 \n(a- |
|
4082 .if \n(80<\n(38 .nr 80 \n(38 |
|
4083 .nr 81 0 |
|
4084 .81 |
|
4085 .rm 81 |
|
4086 .nr 38 \n(b- |
|
4087 .if \n(81<\n(38 .nr 81 \n(38 |
|
4088 .nr 82 0 |
|
4089 .82 |
|
4090 .rm 82 |
|
4091 .nr 38 \n(c- |
|
4092 .if \n(82<\n(38 .nr 82 \n(38 |
|
4093 .35 |
|
4094 .nf |
|
4095 .ll \n(34u |
|
4096 .nr 38 1n |
|
4097 .nr 79 0 |
|
4098 .nr 40 \n(79+(0*\n(38) |
|
4099 .nr 80 +\n(40 |
|
4100 .nr 41 \n(80+(3*\n(38) |
|
4101 .nr 81 +\n(41 |
|
4102 .nr 42 \n(81+(3*\n(38) |
|
4103 .nr 82 +\n(42 |
|
4104 .nr TW \n(82 |
|
4105 .if t .if \n(TW>\n(.li .tm Table at line 2681 file Input is too wide - \n(TW units |
|
4106 .fc |
|
4107 .nr #T 0-1 |
|
4108 .nr #a 0-1 |
|
4109 .eo |
|
4110 .de T# |
|
4111 .ds #d .d |
|
4112 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
4113 .mk ## |
|
4114 .nr ## -1v |
|
4115 .ls 1 |
|
4116 .ls |
|
4117 .. |
|
4118 .ec |
|
4119 .ne \n(a|u+\n(.Vu |
|
4120 .ne \n(b|u+\n(.Vu |
|
4121 .ne \n(c|u+\n(.Vu |
|
4122 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
4123 .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) |
|
4124 .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) |
|
4125 .ta \n(80u \n(81u \n(82u |
|
4126 .nr 31 \n(.f |
|
4127 .nr 35 1m |
|
4128 \&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' |
|
4129 .mk ## |
|
4130 .nr 31 \n(## |
|
4131 .sp |\n(##u-1v |
|
4132 .nr 37 \n(40u |
|
4133 .in +\n(37u |
|
4134 .a+ |
|
4135 .in -\n(37u |
|
4136 .mk 32 |
|
4137 .if \n(32>\n(31 .nr 31 \n(32 |
|
4138 .sp |\n(##u-1v |
|
4139 .nr 37 \n(41u |
|
4140 .in +\n(37u |
|
4141 .b+ |
|
4142 .in -\n(37u |
|
4143 .mk 32 |
|
4144 .if \n(32>\n(31 .nr 31 \n(32 |
|
4145 .sp |\n(##u-1v |
|
4146 .nr 37 \n(42u |
|
4147 .in +\n(37u |
|
4148 .c+ |
|
4149 .in -\n(37u |
|
4150 .mk 32 |
|
4151 .if \n(32>\n(31 .nr 31 \n(32 |
|
4152 .sp |\n(31u |
|
4153 .fc |
|
4154 .nr T. 1 |
|
4155 .T# 1 |
|
4156 .35 |
|
4157 .rm a+ |
|
4158 .rm b+ |
|
4159 .rm c+ |
2731 .TE |
4160 .TE |
2732 .if \n-(b.=0 .nr c. \n(.c-\n(d.-123 |
4161 .if \n-(b.=0 .nr c. \n(.c-\n(d.-123 |
2733 |
4162 |
2734 .LP |
4163 .LP |
2735 .RE |
4164 .RE |
2736 .LP |
4165 .LP |
2737 \f2下線付き\fPで示されたオプションは、Javadoc の基本オプションであり、Javadoc ツールのフロントエンドによって提供され、すべてのドックレットで使用できます。標準ドックレット自体は、下線付きでないオプションを提供します。 |
4166 \f2ゃ帥\fPхず激с潟Javadoc 堺激с潟сJavadoc 若潟潟c箴鴻т戎с障罔羣篏ゃ帥с激с潟箴障 |
2738 .LP |
4167 .LP |
2739 .SS "Javadoc のオプション" |
4168 .SS |
2740 .TP |
4169 Javadoc 激с |
2741 .BI \-overview " path/filename" |
4170 .LP |
2742 .B javadoc |
4171 .RS 3 |
2743 に対して、 |
4172 .TP 3 |
2744 .I path/filename |
4173 \-overview \ path/filename |
2745 で指定された「ソース」ファイルから |
4174 Javadoc 絲障\f2path/filename\fP ф絎純若鴻<ゃ网荀ャ<潟鴻緇鴻网荀若 (\f2overview\-summary.html\fP) 臀絎障\f2path/filename\fP \f2\-sourcepath\fP 吾後障鴻с |
2746 概要ドキュメント用のテキスト |
4175 .LP |
2747 を取得し、概要ページ (\f3overview-summary.html\f1) に配置することを |
4176 \f2filename\fP \f2path\fP 篁紙贋絎с障絽吾\f2overview.html\fP 篁純若鴻弱筝篏宴若吾cc臀障贋臀\f2\-sourcepath\fP c<ゃ腓冴с宴若吾ャ<潟 \f2path\fP 筝荀障違\f2java.lang\fP 宴若吾純若鴻若 \f2/src/classes/java/lang/\fP 翫网荀<ゃ \f2/src/classes/overview.html\fP 臀с障篏睡箴с |
2748 指示します。 |
4177 .LP |
2749 .I path/filename |
4178 \f2path/filename\fP ф絎<ゃゃ网荀潟<潟<ゃс |
2750 は、 |
4179 .LP |
2751 .BR \-sourcepath |
4180 网荀若吾篏Javadoc 茲違宴若後羝<翫с荅括完HTML 若с |
2752 への相対パスです。 |
4181 .LP |
2753 .LP |
4182 网荀若吾帥ゃ\f2\-doctitle\fP c荐絎障 |
2754 .RS |
4183 .LP |
2755 .I filename |
4184 .TP 3 |
2756 と |
4185 \-public |
2757 .IR path |
4186 public 鴻潟<潟若茵腓冴障 |
2758 には、それぞれ任意の名前と場所を指定できますが、通常は、 |
4187 .LP |
2759 .B overview.html |
4188 .TP 3 |
2760 という名前を付けて、ソースツリー内の最上位の |
4189 \-protected |
2761 パッケージディレクトリを含むディレクトリ |
4190 protected public 鴻<潟若茵腓冴障荐絎с |
2762 に配置します。この場所では、 |
4191 .LP |
2763 .B \-sourcepath |
4192 .TP 3 |
2764 がこのファイルを指すので、パッケージを |
4193 \-package |
2765 ドキュメント化する際に path が必要ありません。 |
4194 packageprotected public 鴻<潟若茵腓冴障 |
2766 たとえば、java.lang パッケージのソースツリーが |
4195 .LP |
2767 .BR /src/classes/java/lang/ |
4196 .TP 3 |
2768 の場合、概要ファイルを |
4197 \-private |
2769 .BR /src/classes/overview.html |
4198 鴻鴻<潟若茵腓冴障 |
2770 に配置できます。「使用例」を参照してください。 |
4199 .LP |
2771 .LP |
4200 .TP 3 |
2772 .IR path/filename |
4201 \-help |
2773 で指定するファイルについては、 |
4202 潟ゃ潟茵腓冴障 Javadoc 潟潟茵激с潟筝荀ц;腓冴障 |
2774 「概要コメントファイル」を参照してください。 |
4203 .LP |
2775 .LP |
4204 .TP 3 |
2776 概要ページが作成されるのは、 |
4205 \-doclet\ class |
2777 .B javadoc |
4206 ャ<潟篏帥莎桁鴻<ゃ絎障絎絎絎阪絎鴻綵√絎臂障\f4\-doclet\fP 激с潟篏帥翫Javadoc 罔羣篏帥c HTML 綵√障鴻\f2start(Root)\fP <純障違障莎桁鴻吾鴻\f2\-docletpath\fP 激с潟c絎臂障 |
2778 に 2 つ以上のパッケージ名を渡した場合だけです。 |
4207 .LP |
2779 詳細は、「HTML フレーム」 |
4208 違MIF 若喝冴罨<絎障 |
2780 節を参照してください。 |
4209 .nf |
2781 .LP |
4210 \f3 |
2782 概要ページのタイトルは、 |
4211 .fl |
2783 .B \-doctitle |
4212 \-doclet com.sun.tools.doclets.mif.MIFDoclet |
2784 によって設定されます。 |
4213 .fl |
2785 .RE |
4214 \fP |
2786 .TP |
4215 .fi |
2787 .B \-public |
4216 .LP |
2788 public なクラスとメンバだけを表示します。 |
4217 劫絎茵絎箴ゃ |
2789 .TP |
|
2790 .B \-protected |
|
2791 protected および public なクラスとメンバだけを表示します。 |
|
2792 これはデフォルトの動作です。 |
|
2793 .TP |
|
2794 .B \-package |
|
2795 パッケージ、および protected と public な |
|
2796 クラスとメンバだけを表示します。 |
|
2797 .TP |
|
2798 .B \-private |
|
2799 すべてのクラスとメンバを表示します。 |
|
2800 .TP |
|
2801 .B \-help |
|
2802 オンラインヘルプを表示します。 |
|
2803 .B javadoc |
|
2804 とドックレットのコマンド行オプションの一覧が表示されます。 |
|
2805 .TP |
|
2806 .BI \-doclet " class" |
|
2807 ドキュメントの生成に使う |
|
2808 ドックレットを起動するためのクラスファイルを指定します。 |
|
2809 完全指定の名前を指定してください。 |
|
2810 ドックレットでは、出力の内容と形式を定義します。 |
|
2811 .B \-doclet |
|
2812 オプションが使われていない場合、 |
|
2813 .B javadoc |
|
2814 は標準ドックレットを使ってデフォルトの HTML 形式を生成します。 |
|
2815 このクラスには、 |
|
2816 start(Root) メソッドが含まれていなければなりません。 |
|
2817 この起動クラスへのパスは、 |
|
2818 .B \-docletpath |
|
2819 オプションによって定義されます。 |
|
2820 .LP |
|
2821 たとえば、MIF ドックレットを呼び出すには、次のように指定します。 |
|
2822 .LP |
|
2823 .RS |
|
2824 .ft 3 |
|
2825 .nf |
|
2826 -doclet com.sun.tools.doclets.mif.MIFDoclet |
|
2827 .fi |
|
2828 .ft 1 |
|
2829 .LP |
|
2830 特定のドックレットを実行した完全な例については、 |
|
2831 .fi |
|
2832 http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet |
|
2833 の |
|
2834 .na |
4218 .na |
2835 「\f2Running the MIF Doclet\fP」を参照してください。 |
4219 \f2MIF Doclet ャ<潟\fP @ |
2836 .RE |
4220 .fi |
2837 .TP |
4221 http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.htmlс |
2838 .BI \-docletpath " classpathlist" |
4222 .LP |
2839 .B \-doclet |
4223 .TP 3 |
2840 オプションで指定されているドックレットクラスファイル、 |
4224 \-docletpath\ classpathlist |
2841 およびそれに依存する jar ファイルへのパスを指定します。 |
4225 \f2\-doclet\fP 激с潟ф絎紮鴻<ゃ潟箴絖鴻 jar <ゃ吾鴻絎障紮鴻<ゃ jar <ゃ翫篁ヤ箴 jar <ゃ鴻絎障腟九障鴻障憜c後障鴻絎с障\f2classpathlist\fP 茲違鴻障 JAR <ゃс障 翫鴻障 JAR <ゃSolaris 翫潟 (:)Windows 翫祉潟 (;) у阪障紮鴻с罎膣≪劫翫激с潟筝荀с |
2842 起動クラスファイルが jar ファイル内にある場合、 |
4226 .LP |
2843 例に従って、その jar ファイルへのパスを指定します。 |
4227 jar <ゃ吾鴻箴紮鴻<ゃ障障jar <ゃ障鴻羈 |
2844 絶対パス、または現在のディレクトリからの相対パスを指定できます。 |
|
2845 .IR classpathlist |
|
2846 には、複数のパスまたは jar ファイルを含める |
|
2847 ことができます。その場合、各パスまたは jar ファイルを Solaris ではコロン (\f3:\f1)で、Windows ではセミコロン (;) で区切ります。 |
|
2848 目的のドックレットの開始クラスがすでに検索パス内にある場合は、 |
|
2849 このオプションは不要です。 |
|
2850 .LP |
|
2851 次の例の jar ファイルへのパスには、ドックレットの |
|
2852 開始クラスファイルが含まれています。 |
|
2853 jar ファイル名が含まれている点に注意してください。 |
|
2854 .nf |
4228 .nf |
2855 \f3 |
4229 \f3 |
2856 .fl |
4230 .fl |
2857 \-docletpath /home/user/mifdoclet/lib/mifdoclet.jar |
4231 \-docletpath /home/user/mifdoclet/lib/mifdoclet.jar |
2858 .fl |
4232 .fl |
2859 \fP |
4233 \fP |
2860 .fi |
4234 .fi |
2861 次はドックレットの開始クラスファイルのパスの例です。 |
4235 紮鴻<ゃ鴻箴鴻<ゃャ鴻羈 |
2862 クラスファイル名が省略されていることに注意してください。 |
|
2863 .nf |
4236 .nf |
2864 \f3 |
4237 \f3 |
2865 .fl |
4238 .fl |
2866 \-docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/ |
4239 \-docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/ |
2867 .fl |
4240 .fl |
2868 \fP |
4241 \fP |
2869 .fi |
4242 .fi |
2870 特定のドックレットを実行した完全な例については、 |
4243 劫絎茵絎箴ゃ |
2871 .fi |
|
2872 http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet |
|
2873 の |
|
2874 .na |
4244 .na |
2875 「\f2Running the MIF Doclet\fP」を参照してください。 |
4245 \f2MIF Doclet ャ<潟\fP @ |
2876 .RE |
4246 .fi |
2877 .LP |
4247 http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.htmlс |
2878 .TP |
4248 .LP |
2879 .B \-1.1 |
4249 .TP 3 |
2880 この機能は、javadoc 1.4 から削除されました。代替の機能は |
4250 \-1.1 |
2881 存在しません。このオプションは、javadoc 1.1 で生成される |
4251 \f2罘純Javadoc 1.4 сゃ障篁f炊純障激с潟Javadoc 1.1 c紊荀罘純ゃャ<潟篏с ャ絖鴻泣若障激с潟綽荀翫Javadoc 1.2 障 1.3 篏睡\fP |
2882 ドキュメントの外観と機能 (サポートされなくなった、入れ子になったクラスを |
4252 .LP |
2883 含む) を備えたドキュメントを作成するためのものでした。 |
|
2884 このオプションが必要であれば、代わ |
|
2885 りに javadoc 1.2 または 1.3 を使用してください。 |
|
2886 .TP 3 |
4253 .TP 3 |
2887 \-source release |
4254 \-source release |
2888 受け付けるソースコードのバージョンを指定します。\f2release\fP には次の値を指定できます。 |
4255 篁純若鴻潟若若吾с潟絎障\f2release\fP 罨<ゃ絎с障 |
2889 .LP |
4256 .LP |
2890 .TS |
4257 .TS |
2891 ; |
4258 .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 |
2892 l l. |
4259 .de 35 |
2893 1.5 T{ |
4260 .ps \n(.s |
2894 Javadoc は、JDK 1.5 で導入された総称機能および他の言語機能を含んだコードを受け付けます。-source フラグを指定しないと、コンパイラはデフォルトとして 1.5 の動作をします。 |
4261 .vs \n(.vu |
2895 T} |
4262 .in \n(.iu |
2896 1.4 T{ |
4263 .if \n(.u .fi |
2897 Javadoc は、JDK 1.4 で導入された、アサーションを含むコードを受け付けます。 |
4264 .if \n(.j .ad |
2898 T} |
4265 .if \n(.j=0 .na |
2899 1.3 T{ |
4266 .. |
2900 Javadoc は、JDK 1.3 以降に導入されたアサーション、総称機能、または他の言語機能をサポートしません。 |
4267 .nf |
2901 T} |
4268 .nr #~ 0 |
|
4269 .if n .nr #~ 0.6n |
|
4270 .ds #d .d |
|
4271 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
4272 .fc |
|
4273 .nr 33 \n(.s |
|
4274 .rm 80 81 |
|
4275 .nr 34 \n(.lu |
|
4276 .eo |
|
4277 .am 81 |
|
4278 .br |
|
4279 .di a+ |
|
4280 .35 |
|
4281 .ft \n(.f |
|
4282 .ll \n(34u*1u/3u |
|
4283 .if \n(.l<\n(81 .ll \n(81u |
|
4284 .in 0 |
|
4285 Javadoc JDK 1.5 уャ膩霡違割荐茯罘純潟若篁障\f3\-source\fP 違絎潟潟ゃ 1.5 篏障 |
|
4286 .br |
|
4287 .di |
|
4288 .nr a| \n(dn |
|
4289 .nr a- \n(dl |
|
4290 .. |
|
4291 .ec \ |
|
4292 .eo |
|
4293 .am 81 |
|
4294 .br |
|
4295 .di b+ |
|
4296 .35 |
|
4297 .ft \n(.f |
|
4298 .ll \n(34u*1u/3u |
|
4299 .if \n(.l<\n(81 .ll \n(81u |
|
4300 .in 0 |
|
4301 Javadoc JDK 1.4 уャ≪泣若激с潟潟若篁障 |
|
4302 .br |
|
4303 .di |
|
4304 .nr b| \n(dn |
|
4305 .nr b- \n(dl |
|
4306 .. |
|
4307 .ec \ |
|
4308 .eo |
|
4309 .am 81 |
|
4310 .br |
|
4311 .di c+ |
|
4312 .35 |
|
4313 .ft \n(.f |
|
4314 .ll \n(34u*1u/3u |
|
4315 .if \n(.l<\n(81 .ll \n(81u |
|
4316 .in 0 |
|
4317 Javadoc JDK 1.3 篁ラ絨ャ≪泣若激с潟膩霡違障篁荐茯罘純泣若障 |
|
4318 .br |
|
4319 .di |
|
4320 .nr c| \n(dn |
|
4321 .nr c- \n(dl |
|
4322 .. |
|
4323 .ec \ |
|
4324 .35 |
|
4325 .nf |
|
4326 .ll \n(34u |
|
4327 .nr 80 0 |
|
4328 .nr 31 0 |
|
4329 .nr 32 0 |
|
4330 .nr 38 \w\f31 |
|
4331 .if \n(31<\n(38 .nr 31 \n(38 |
|
4332 .nr 38 \w.5\fP |
|
4333 .if \n(32<\n(38 .nr 32 \n(38 |
|
4334 .nr 38 \w\f31 |
|
4335 .if \n(31<\n(38 .nr 31 \n(38 |
|
4336 .nr 38 \w.4\fP |
|
4337 .if \n(32<\n(38 .nr 32 \n(38 |
|
4338 .nr 38 \w\f31 |
|
4339 .if \n(31<\n(38 .nr 31 \n(38 |
|
4340 .nr 38 \w.3\fP |
|
4341 .if \n(32<\n(38 .nr 32 \n(38 |
|
4342 .80 |
|
4343 .rm 80 |
|
4344 .nr 60 \n(31 |
|
4345 .nr 38 \n(60+\n(32 |
|
4346 .if \n(38>\n(80 .nr 80 \n(38 |
|
4347 .if \n(38<\n(80 .nr 60 +(\n(80-\n(38)/2 |
|
4348 .nr 81 0 |
|
4349 .81 |
|
4350 .rm 81 |
|
4351 .nr 38 \n(a- |
|
4352 .if \n(81<\n(38 .nr 81 \n(38 |
|
4353 .nr 38 \n(b- |
|
4354 .if \n(81<\n(38 .nr 81 \n(38 |
|
4355 .nr 38 \n(c- |
|
4356 .if \n(81<\n(38 .nr 81 \n(38 |
|
4357 .35 |
|
4358 .nf |
|
4359 .ll \n(34u |
|
4360 .nr 38 1n |
|
4361 .nr 79 0 |
|
4362 .nr 40 \n(79+(0*\n(38) |
|
4363 .nr 80 +\n(40 |
|
4364 .nr 60 +\n(40 |
|
4365 .nr 41 \n(80+(3*\n(38) |
|
4366 .nr 81 +\n(41 |
|
4367 .nr TW \n(81 |
|
4368 .if t .if \n(TW>\n(.li .tm Table at line 2791 file Input is too wide - \n(TW units |
|
4369 .fc |
|
4370 .nr #T 0-1 |
|
4371 .nr #a 0-1 |
|
4372 .eo |
|
4373 .de T# |
|
4374 .ds #d .d |
|
4375 .if \(ts\n(.z\(ts\(ts .ds #d nl |
|
4376 .mk ## |
|
4377 .nr ## -1v |
|
4378 .ls 1 |
|
4379 .ls |
|
4380 .. |
|
4381 .ec |
|
4382 .ne \n(a|u+\n(.Vu |
|
4383 .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) |
|
4384 .ta \n(60u \n(80u \n(81u |
|
4385 .nr 31 \n(.f |
|
4386 .nr 35 1m |
|
4387 \&\h'|\n(40u'\f31.5\fP\h'|\n(41u' |
|
4388 .mk ## |
|
4389 .nr 31 \n(## |
|
4390 .sp |\n(##u-1v |
|
4391 .nr 37 \n(41u |
|
4392 .in +\n(37u |
|
4393 .a+ |
|
4394 .in -\n(37u |
|
4395 .mk 32 |
|
4396 .if \n(32>\n(31 .nr 31 \n(32 |
|
4397 .sp |\n(31u |
|
4398 .ne \n(b|u+\n(.Vu |
|
4399 .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) |
|
4400 .ta \n(60u \n(80u \n(81u |
|
4401 .nr 31 \n(.f |
|
4402 .nr 35 1m |
|
4403 \&\h'|\n(40u'\f31.4\fP\h'|\n(41u' |
|
4404 .mk ## |
|
4405 .nr 31 \n(## |
|
4406 .sp |\n(##u-1v |
|
4407 .nr 37 \n(41u |
|
4408 .in +\n(37u |
|
4409 .b+ |
|
4410 .in -\n(37u |
|
4411 .mk 32 |
|
4412 .if \n(32>\n(31 .nr 31 \n(32 |
|
4413 .sp |\n(31u |
|
4414 .ne \n(c|u+\n(.Vu |
|
4415 .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) |
|
4416 .ta \n(60u \n(80u \n(81u |
|
4417 .nr 31 \n(.f |
|
4418 .nr 35 1m |
|
4419 \&\h'|\n(40u'\f31.3\fP\h'|\n(41u' |
|
4420 .mk ## |
|
4421 .nr 31 \n(## |
|
4422 .sp |\n(##u-1v |
|
4423 .nr 37 \n(41u |
|
4424 .in +\n(37u |
|
4425 .c+ |
|
4426 .in -\n(37u |
|
4427 .mk 32 |
|
4428 .if \n(32>\n(31 .nr 31 \n(32 |
|
4429 .sp |\n(31u |
|
4430 .fc |
|
4431 .nr T. 1 |
|
4432 .T# 1 |
|
4433 .35 |
|
4434 .rm a+ |
|
4435 .rm b+ |
|
4436 .rm c+ |
2902 .TE |
4437 .TE |
2903 .if \n-(b.=0 .nr c. \n(.c-\n(d.-14 |
4438 .if \n-(b.=0 .nr c. \n(.c-\n(d.-14 |
2904 .LP |
4439 .LP |
2905 javac でコードをコンパイルするときに使用した値に対応する \f2release\fP の値を使用します。 |
4440 javac с潟若潟潟ゃ篏睡ゃ絲上 \f2release\fP ゃ篏睡障 |
2906 .LP |
4441 .LP |
2907 .TP |
4442 .TP 3 |
2908 .BI \-sourcepath " sourcepathlist" |
4443 \-sourcepath\ sourcepathlist |
2909 .B javadoc |
4444 \f2javadoc\fP 潟潟宴若後障 \f2\-subpackages\fP 羝<純若鴻<ゃ (\f2.java\fP) 罎膣≪鴻絎障\f2sourcepathlist\fP 潟 (\f2:\fP) у阪c茲違鴻с障Javadoc 若絎剛札筝鴻泣c罎膣≪障激с潟篏帥cャ<潟純若鴻<ゃ篏臀с篏ャ<潟ャ<潟純若鴻<ゃ膓帥潟<潟ゃ純若鴻<ゃ篏臀腆肴с障 |
2910 コマンドにパッケージ名または \-subpackages |
4445 .LP |
2911 を渡す際に、 |
4446 \f2\-sourcepath\fP 激с潟javadoc 潟潟宴若後羝<篏睡с障 \f2javadoc\fP 潟潟羝< \f2.java\fP <ゃ鴻罎膣≪障\f2.java\fP <ゃ罎膣≪<ゃc cd c腱糸障<ゃ鴻障 (1 や札筝鴻ャ<潟)\f2\-sourcepath\fP ャ翫Javadoc 鴻鴻篏帥c純若鴻<ゃ罎膣≪障 (\-classpath )c \-sourcepath 鴻鴻ゃс\-classpath ャ宴若後 Javadoc 羝<Javadoc 憜c潟泣c純若鴻<ゃ罎膣≪障 |
2912 ソースファイル (.java) 検索用のパスを指定します。 |
4447 .LP |
2913 .BI sourcepathlist |
4448 \f2sourcepathlist\fP ャ<潟宴若後純若鴻若若c荐絎障違\f2com.mypackage\fP 宴若吾ャ<潟翫純若鴻<ゃ罨<贋障 |
2914 には、コロン (\f3:\f1) |
4449 .nf |
2915 で区切った複数のパスを含めることができます。 |
4450 \f3 |
2916 .B Javadoc |
4451 .fl |
2917 ツールは、指定されたパス以下のすべての |
4452 /home/user/src/com/mypackage/*.java |
2918 サブディレクトリを検索します。 このオプションを使って、 |
4453 .fl |
2919 ドキュメント化されるソースファイルの位置だけでなく、 |
4454 \fP |
2920 それ自体はドキュメント化されていないが、ドキュメント化 |
4455 .fi |
2921 されているソースファイルから継承されたコメントをもつ |
4456 翫罨< \f2sourcepath\fP \f2/home/user/src\fPゃ障 \f2com/mypackage\fP c絎宴若後 \f2com.mypackage\fP 絎障 |
2922 ソースファイルの位置も確認できます。 |
4457 .nf |
2923 .LP |
4458 \f3 |
2924 .B \-sourcepath |
4459 .fl |
2925 オプションは、 |
4460 % \fP\f3javadoc \-sourcepath /home/user/src/ com.mypackage\fP |
2926 .B javadoc |
4461 .fl |
2927 コマンドを使ってパッケージ名を指定するときにだけ使用でき、 |
4462 .fi |
2928 .B javadoc |
4463 号純若鴻鴻ゃ宴若後g (荐) \\紊宴若吾 (C:\\user\\src\\com\\mypackage) 茹c膂≦с\f2/home/user/src/com/mypackage\fP. |
2929 コマンドに渡される |
4464 .LP |
2930 .B .java |
4465 2 ゃ純若鴻鴻荐絎罨<障 |
2931 ファイルは検索できないことに注意してください。 |
4466 .nf |
2932 .B .java |
4467 \f3 |
2933 ファイルを検索するには、 |
4468 .fl |
2934 そのディレクトリに移動するか、 |
4469 % \fP\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com.mypackage\fP |
2935 各ファイルの前にそのパスを付けます (「1 つ以上 |
4470 .fl |
2936 のパッケージのドキュメント化」を参照)。 |
4471 .fi |
2937 .B \-sourcepath |
4472 .LP |
2938 が省略された場合は、 |
4473 .TP 3 |
2939 .B javadoc |
4474 \-classpath\ classpathlist |
2940 はクラスパスを使ってソースファイルを検索します ( |
4475 Javadoc с (\f2.class\fP <ゃ) 罎膣≪鴻絎障 с鴻ャ<潟鴻鴻cс鴻鴻с\f2classpathlist\fP 潟 (\f2:\fP) у阪c茲違鴻с障Javadoc 若絎鴻篁ヤ鴻泣c罎膣≪障\f2classpathlist\fP 絎 |
2941 .B \-classpath |
4476 .na |
2942 を参照)。 したがって、 |
4477 \f2鴻\fP @ |
2943 .B \-sourcepath |
4478 .fi |
2944 のデフォルトは |
4479 http://java.sun.com/javase/6/docs/technotes/tools/index.html#generalャ<潟腓冴緇c |
2945 .B \-classpath |
4480 .LP |
2946 の値です。 |
4481 \f2\-sourcepath\fP ャ翫Javadoc 若\f2\-classpath\fP 篏帥c鴻<ゃс純若鴻<ゃ罎膣≪障 (筝篏篋с)c純若鴻<ゃ鴻<ゃャ鴻罎膣≪綽荀翫\f2\-sourcepath\fP \f2\-classpath\fP 筝≧鴻篏帥障 |
2947 .B -classpath |
4482 .LP |
2948 を省略してパッケージ名を |
4483 違\f2com.mypackage\fP ャ<潟翫純若鴻<ゃc \f2/home/user/src/com/mypackage\fP 宴若吾 \f2/home/user/lib\fP ゃ篏帥с違罨<絎障 |
2949 .BR javadoc |
4484 .nf |
2950 に渡した場合、 |
4485 \f3 |
2951 .BR javadoc |
4486 .fl |
2952 は、ソースファイルの現在のディレクトリ (およびサブディレクトリ) を |
4487 % \fP\f3javadoc \-classpath /home/user/lib \-sourcepath /home/user/src com.mypackage\fP |
2953 検索します。 |
4488 .fl |
2954 .LP |
4489 .fi |
2955 .RS |
4490 祉若罕\f2\-classpath\fP 絎翫CLASSPATH 医紊違荐絎違Javadoc 若医紊違篏帥障<荐絎翫Javadoc 若憜c鴻罎膣≪障 |
2956 .I sourcepathlist |
4491 .LP |
2957 では、ドキュメント化するパッケージ名の |
4492 Javadoc 若≦宍罘純鴻潟若鴻鴻∫cJavadoc 若 \f2\-classpath\fP 篏睡若吟若鴻罎膣≪号ゃ荅括完 |
2958 ソースツリーのルートディレクトリを |
4493 .na |
2959 設定します。たとえば、ソースファイルが次の |
4494 \f2鴻罎膣∽号\fP @ |
2960 場所にある |
4495 .fi |
2961 .B com.mypackage |
4496 http://java.sun.com/javase/6/docs/technotes/tools/findingclasses.html荀с |
2962 という名前のパッケージをドキュメント化するとします。 |
4497 .LP |
2963 .LP |
4498 箴水筝\f2*\fP 若劫鴻壕膣c≦宍絖 \f2.jar\fP 障 \f2.JAR\fP ゃ鴻<ゃ鴻絎帥障 (Java 違 2 ゃ若喝冴阪ャс) |
2964 .RS |
4499 .br |
2965 .ft 3 |
4500 .br |
2966 .nf |
4501 違c \f2foo\fP \f2a.jar\fP \f2b.JAR\fP 障翫鴻壕膣 \f2foo/*\fP \f2A.jar:b.JAR\fP 絮障 JAR <ゃ絎障鴻<ゃ絎c鴻 JAR <ゃ障障\f2*\fP 鴻鴻潟潟c鴻 JAR <ゃ鴻絮障\f2CLASSPATH\fP 医紊違絎臂罕絮障鴻鴻ゃ若絮綽Java 篁潟激潟莎桁絎茵障c\f2System.getenv("CLASSPATH")\fP 若喝冴医茵Java 違絮ゃ若茯茘障 |
2967 /home/user/src/com/mypackage/*.java |
|
2968 .fi |
|
2969 .ft 1 |
|
2970 .RE |
|
2971 .LP |
|
2972 この場合、次のようにしてソースパスを |
|
2973 .BR /home/user/src |
|
2974 、つまり |
|
2975 .BR com.mypackage |
|
2976 を含むディレクトリに指定し、それからパッケージ名 |
|
2977 .BR com.mypackage |
|
2978 を指定します。 |
|
2979 .LP |
|
2980 .RS |
|
2981 .ft 3 |
|
2982 .nf |
|
2983 % javadoc \-sourcepath /home/user/src/ com.mypackage |
|
2984 .fi |
|
2985 .ft 1 |
|
2986 .RE |
|
2987 .LP |
|
2988 これは、ソースパスの値とパッケージ名をつなげて、 |
|
2989 ドットをスラッシュ (/) に変えると、以下のパッケージのフルパス |
|
2990 になることに注目すると覚えやすいでしょう。 |
|
2991 .LP |
|
2992 .RS |
|
2993 .ft 3 |
|
2994 .BR /home/user/src/com/mypackage |
|
2995 .RE |
|
2996 .LP |
|
2997 2 つのソースパスを指定するには、次のようにします。 |
|
2998 .LP |
|
2999 .RS |
|
3000 .ft 3 |
|
3001 .nf |
|
3002 % javadoc \-sourcepath /home/user/src/:/home/user2/src com.mypackage |
|
3003 .fi |
|
3004 .ft 1 |
|
3005 .RE |
|
3006 .LP |
|
3007 .RE |
|
3008 .TP |
|
3009 .BI \-classpath " classpathlist" |
|
3010 .B javadoc |
|
3011 が参照されるクラスの検索を行うパスを指定します。 |
|
3012 参照されるクラス (\f3.class\f1) とは、 |
|
3013 ドキュメント化されるクラスとそれらのクラスによって |
|
3014 参照される任意のクラスのことです。 |
|
3015 .B javadoc |
|
3016 は、指定されたパス以下のすべてのサブディレクトリで |
|
3017 検索を行います。 |
|
3018 .I classpathlist |
|
3019 には、パス間をコロン (\f3:\f1) で区切って複数のパスを |
|
3020 含めることができます。 |
|
3021 .B javadoc |
|
3022 ツールは、指定されたパス以下の |
|
3023 すべてのサブディレクトリを検索します。 |
|
3024 .IR classpathlist |
|
3025 の指定 |
|
3026 については、クラスパスのドキュメントを参照してください。 |
|
3027 .LP |
|
3028 .RS |
|
3029 .B \-sourcepath |
|
3030 を省略した場合は、 |
|
3031 .B javadoc |
|
3032 ツールは、クラスファイル (下位互換用) とともに、 |
|
3033 .B \-classpath |
|
3034 を使ってソースファイルを検索します。このため、 |
|
3035 異なるパス内のソースファイルおよびクラスファイルを検索する場合は、 |
|
3036 .B \-sourcepath |
|
3037 と |
|
3038 .BR \-classpath |
|
3039 の両方を使います。 |
|
3040 .LP |
|
3041 たとえば、 |
|
3042 .BR com.mypackage |
|
3043 をドキュメント化したい場合に、パッケージのクラスがディレクトリ |
|
3044 .BR /home/user/src/com/mypackage |
|
3045 にあり、このパッケージが |
|
3046 .BR /home/user/lib |
|
3047 内のライブラリを使う場合は、次のように指定します。 |
|
3048 .LP |
|
3049 .RS |
|
3050 .ft 3 |
|
3051 .nf |
|
3052 % javadoc \-classpath /home/user/lib \-sourcepath /home/user/src com.mypackage |
|
3053 .fi |
|
3054 .ft 1 |
|
3055 .RE |
|
3056 .LP |
|
3057 ほかのツールと同様に、 |
|
3058 .BR \-classpath |
|
3059 を指定しない場合は、CLASSPATH 環境変数が |
|
3060 設定されていれば、 |
|
3061 .B javadoc |
|
3062 ツールはこの環境変数を使います。 |
|
3063 どちらも設定されていない場合 |
|
3064 は、 |
|
3065 .B javadoc |
|
3066 ツールは現在のディレクトリでクラスを検索します。 |
|
3067 .LP |
|
3068 .B javadoc |
|
3069 ツールが拡張機能クラスおよびブートストラップクラスと通信する際に、 |
|
3070 .B -classpath |
|
3071 を使ってユーザクラスを検索する方法についての |
|
3072 詳細は、「クラスの検索方法」を |
|
3073 参照してください。 |
|
3074 .LP |
|
3075 便宜上、\f2*\fP のベース名を含むクラスパス要素は、ディレクトリ内の拡張子 \f2.jar\fP または \f2.JAR\fP を持つすべてのファイルのリストを指定するのと同じであるとみなされます (Java プログラムはこの 2 つの呼び出しを区別できない)。 |
|
3076 .br |
|
3077 .br |
|
3078 たとえば、ディレクトリ \f2foo\fP に \f2a.jar\fP と \f2b.JAR\fP が含まれている場合、クラスパス要素 \f2foo/*\fP は \f2A.jar:b.JAR\fP に展開されます。ただし、JAR ファイルの順番は未定義となります。このリストには、隠しファイルも含め、指定されたディレクトリ内のすべての JAR ファイルが含まれます。\f2*\fP だけから成るクラスパスエントリは、カレントディレクトリ内のすべての JAR ファイルのリストに展開されます。\f2CLASSPATH\fP 環境変数も、定義時には同様に展開されます。クラスパスのワイルドカード展開は必ず、Java 仮想マシンの起動前に実行されます。したがって、\f2System.getenv("CLASSPATH")\fP 呼び出しなどの環境に対する問い合わせを行わない限り、展開されていないワイルドカードを Java プログラムが認識することはありません。 |
|
3079 .LP |
4502 .LP |
3080 .TP 3 |
4503 .TP 3 |
3081 \-subpackages\ \ package1:package2:... |
4504 \-subpackages\ \ package1:package2:... |
3082 ソースファイルから指定されたパッケージおよびそのサブパッケージ内に再帰的にドキュメントを生成します。このオプションは、ソースコードに新しいサブパッケージを追加する際に便利です。新しいサブパッケージは自動的に組み込まれます。各 package 引数は、任意の最上位サブパッケージ (java など) または完全指定のパッケージ (javax.swing など) になります。ソースファイルを含める必要はありません。引数は、コロンで区切られます (すべてのオペレーティングシステム)。ワイルドカードは不要です (使用不可)。パッケージの検索場所を指定するには、\-sourcepath を使用します。このオプションは、「ソースファイルの処理」で説明したとおり、ソースツリーにあるがパッケージには属していないソースファイルを処理しないので役立ちます。 |
4505 純若鴻<ゃ絎宴若吾潟泣宴若後絽亥ャ<潟障激с潟純若鴻潟若違泣宴若吾菴遵箴水с違泣宴若吾腟粋昭障障 \f2package\fP 綣違篁紙筝篏泣宴若 (\f2java\fP ) 障絎絎宴若 (\f2javax.swing\fP ) 障純若鴻<ゃ綽荀障綣違潟潟у阪障 (鴻若c潟違激鴻)ゃ若筝荀с (篏睡筝)宴若吾罎膣√贋絎\f2\-sourcepath\fP 篏睡障激с潟純若鴻<ゃц純若鴻若宴若吾絮純若鴻<ゃу醜腴<障 |
3083 .LP |
4506 .LP |
3084 次に例を示します。 |
4507 箴腓冴障 |
3085 .nf |
4508 .nf |
3086 \f3 |
4509 \f3 |
3087 .fl |
4510 .fl |
3088 % \fP\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax.swing\fP |
4511 % \fP\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax.swing\fP |
3089 .fl |
4512 .fl |
3090 .fi |
4513 .fi |
3091 このコマンドは、「java」および「javax.swing」という名前のパッケージとこれらのサブパッケージ全部のドキュメントを生成します。 |
4514 潟潟java潟javax.swing宴若吾泣宴若後ャ<潟障 |
3092 .LP |
4515 .LP |
3093 \f2\-exclude\fP とともに \f2\-subpackages\fP を使用すると、特定のパッケージを除外できます。 |
4516 \f2\-exclude\fP \f2\-subpackages\fP 篏睡劫宴若吾ゅс障 |
3094 .LP |
4517 .LP |
3095 .TP 3 |
4518 .TP 3 |
3096 \-exclude\ \ packagename1:packagename2:... |
4519 \-exclude\ \ packagename1:packagename2:... |
3097 指定されたパッケージとそのサブパッケージを \f2\-subpackages\fP によって作成されたリストから無条件に除外します。過去の \f2\-subpackages\fP オプションの指定によって組み込まれたパッケージ、または将来組み込まれるパッケージも除外の対象となります。次に例を示します。 |
4520 絎宴若吾泣宴若吾 \f2\-subpackages\fP c篏鴻≧>散ゅ障サ \f2\-subpackages\fP 激с潟絎c腟粋昭障宴若吾障絨ョ粋昭障宴若吾ゅ絲乗院障箴腓冴障 |
3098 .nf |
4521 .nf |
3099 \f3 |
4522 \f3 |
3100 .fl |
4523 .fl |
3101 % \fP\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude java.net:java.lang\fP |
4524 % \fP\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude java.net:java.lang\fP |
3102 .fl |
4525 .fl |
3103 .fi |
4526 .fi |
3104 このうち、\f2java.io\fP、\f2java.util\fP、\f2java.math\fP は組み込まれますが、\f2java.net\fP と \f2java.lang\fP 以下のパッケージは除外されます。ただし、\f2java.lang\fP のサブパッケージである \f2java.lang.ref\fP は除外されます。 |
4527 <\f2java.io\fP\f2java.util\fP\f2java.math\fP 腟粋昭障障\f2java.net\fP \f2java.lang\fP 篁ヤ宴若吾ゅ障\f2java.lang\fP 泣宴若吾с \f2java.lang.ref\fP ゅ障 |
3105 .RE |
4528 .LP |
3106 .TP |
4529 .TP 3 |
3107 .BI \-bootclasspath " classpathlist" |
4530 \-bootclasspath\ classpathlist |
3108 ブートクラスが存在するパスを指定します。 |
4531 若鴻絖鴻絎障若鴻絽吾Java 若潟≪鴻с若鴻鴻Javadoc 若純若鴻<ゃ鴻<ゃ「篏帥罎膣≪鴻筝с荅括完 |
3109 ブートクラスとは、Java プラットフォームクラスのことです。 |
4532 .na |
3110 .B bootclasspath |
4533 \f2javac javadoc 鴻罎膣≪号\fP @ |
3111 は、 |
4534 .fi |
3112 .B javadoc |
4535 http://java.sun.com/javase/6/docs/technotes/tools/findingclasses.html#srcfilesс\f2classpathlist\fP 茲違c潟 (:) у阪障 |
3113 ツールがソースファイルとクラスファイルを探すときに |
4536 .LP |
3114 使う検索パスの一部です。詳細は、 |
4537 .TP 3 |
3115 「Javac と Javadoc がクラスを検索する方法」 を |
4538 \-extdirs\ dirlist |
3116 参照してください。 |
4539 ≦宍罘純鴻絖c絎障≦宍罘純鴻Java ≦宍罘醇罕篏帥鴻鴻сextdirs Javadoc 若純若鴻<ゃ鴻<ゃ「篏帥罎膣≪鴻筝с荅括完菴違 \f2\-classpath\fP с\f2dirlist\fP 茲違c潟 (:) у阪障 |
3117 .I classpathlist |
4540 .LP |
3118 内の複数の |
4541 .TP 3 |
3119 クラスパスリストは、コロン (:) で区切ります。 |
4542 \-verbose |
3120 .TP |
4543 javadoc 絎茵筝荅括完<祉若吾茵腓冴障verbose 激с潟絎純若鴻<ゃ若ャ<潟 (純若鴻<ゃ 1 ゃ<祉若)潟純若<祉若吾茵腓冴障verbose 激с潟絎 Java 純若鴻<ゃ茹f荀 (腱篏) 菴遵<祉若吾茵腓冴障 |
3121 .BI \-extdirs " dirlist" |
4544 .LP |
3122 拡張機能クラスが存在するディレクトリを指定します。 |
4545 .TP 3 |
3123 拡張機能クラスは、Java 拡張機能 |
4546 \-quiet |
3124 機構を使うすべてのクラスです。拡張機能ディレクトリ ( |
4547 若<祉若吾障茘<祉若娯札紊<祉若吾吟茘若茵腓冴劫障若吾с恰絖吟障 |
3125 .B extdirs |
|
3126 ) は、 |
|
3127 .B javadoc |
|
3128 ツールがソースファイルとクラスファイルを探すときに使う検索パスの一部です。 |
|
3129 詳細は、上の |
|
3130 .B \-classpath |
|
3131 を参照してください。 |
|
3132 .I dirlist |
|
3133 内の複数のディレクトリは、 |
|
3134 コロン (:) で区切ります。 |
|
3135 .TP |
|
3136 .B \-verbose |
|
3137 .B javadoc |
|
3138 の実行中に詳細なメッセージを表示します。冗長オプションを |
|
3139 指定しない場合は、ソースファイルのロード時、ドキュメントの |
|
3140 生成時 (ソースファイルごとに 1 つのメッセージ)、およびソート時に |
|
3141 メッセージが表示されます。冗長オプションを指定した場合は、 |
|
3142 各 java ソースファイルの解析に要したミリ秒数などの |
|
3143 追加メッセージを表示します。 |
|
3144 .TP |
|
3145 .BI \-quiet |
|
3146 エラーメッセージ以外、および警告メッセージ以外の |
|
3147 メッセージを除外し、 |
|
3148 エラーメッセージおよび警告メッセージだけを |
|
3149 表示して見つけやすくします。 |
|
3150 また、バージョン文字列の表示も抑制します。 |
|
3151 .LP |
4548 .LP |
3152 .TP 3 |
4549 .TP 3 |
3153 \-breakiterator\ |
4550 \-breakiterator\ |
3154 英語言語というロケール固有のアルゴリズムではなく、\f2java.text.BreakIterator\fP の国際化された文境界を使用して、英文の最初の文の終わりを判断します (他のすべてのロケールはすでに \f2BreakIterator\fP を使用)。「\f2最初の文\fP」とは、パッケージ、クラス、またはメンバの主説明での最初の文のことです。この文は、パッケージ、クラス、またはメンバの要約にコピーされ、アルファベット順のインデックスにコピーされます。 |
4551 沿荐茯宴若堺≪眼冴с |
3155 .LP |
4552 .na |
3156 JDK 1.2 以降、BreakIterator クラスは、英語を除くすべての言語の文の終わりを判断するために、すでに使用されています。したがって、1.2 以降では、\f2\-breakiterator\fP オプションは英文以外には効果がありません。英文には、次のような独自のデフォルトのアルゴリズムがあります。 |
4553 \f2java.text.BreakIterator\fP @ |
3157 .RS 3 |
4554 .fi |
3158 .TP 2 |
4555 http://java.sun.com/javase/6/docs/api/java/text/BreakIterator.html 初紜篏睡掩腟ゆ障 (篁鴻宴若с \f2BreakIterator\fP 篏睡)\f2\fP宴若吾鴻障<潟若筝肢сс宴若吾鴻障<潟若荀膣潟若≪<ゃ潟鴻潟若障 |
3159 o |
4556 .LP |
3160 英文のデフォルトの文区切りアルゴリズム \- 空白または HTML ブロックタグ (\f2<P>\fP など) が続くピリオドで停止する |
4557 JDK 1.2 篁ラBreakIterator 鴻沿ゃ鴻荐茯腟ゆс篏睡障c1.2 篁ラс\f2\-breakiterator\fP 激с潟掩篁ュ号障掩罨<≪眼冴障 |
3161 .TP 2 |
4558 .RS 3 |
3162 o |
4559 .TP 2 |
3163 breakiterator 文区切りアルゴリズム \- 一般に、次の語が大文字で始まる場合、空白文字が続くピリオド、疑問符、または感嘆符で停止する。このアルゴリズムでは、ほとんどの省略表記が処理される (「The serial no. is valid」は処理されるが「Mr. Smith」は処理されない)。HTML タグや、数字または記号で始まる文では停止しない。HTML タグに埋め込まれている場合でも、「../filename」の最後のピリオドで停止する |
4560 o |
3164 .RE |
4561 掩阪≪眼冴 \- 腥榊純障 HTML 帥 (\f2<P>\fP ) 膓у罩≪ |
3165 .RS 3 |
4562 .TP 2 |
3166 .LP |
4563 o |
3167 .LP |
4564 breakiterator 阪≪眼冴 \- 筝罨<茯紊ф絖у障翫腥榊醇絖膓霳障膃у罩≪≪眼冴с祉ヨ;荐 (The serial no. is validMr. Smith)HTML 帥違医障荐垩у障с罩≪HTML 帥違莨若障翫с../filename緇у罩≪ |
3168 注: 1.5.0 からは、1.4.x に設けられていた breakiterator 警告メッセージを削除し、デフォルトの文区切りアルゴリズムを変更していません。つまり、\-breakiterator オプションは、1.5.0 ではデフォルトではなくなり、またデフォルトにするつもりもありません。これは、「次のメジャーリリース」(1.5.0) でデフォルトを変更するという、以前の目的とは逆になっています。つまり、ソースコードを変更せず、1.4.x での breakiterator 警告を除去していない場合でも、1.5.0 からは何もする必要がなく、警告は消滅しています。この逆戻りの理由は、breakiterator をデフォルトにするメリットよりも、デフォルトにするために必要となる、互換性のないソースの変更の方が負担が大きかったためです。これに費やした作業や混乱が無駄になり残念です。 |
4565 .RE |
3169 .LP |
4566 .RS 3 |
3170 .TP |
4567 |
3171 .BI \-locale " language_country_variant" |
4568 .LP |
3172 .B 重要: |
4569 .LP |
3173 \-locale オプションは、標準ドックレットやその他のドックレット |
4570 羈: 1.5.0 1.4.x 荐 breakiterator 茘<祉若吾ゃ阪≪眼冴紊眼障ゃ障\\\-breakiterator 激с潟1.5.0 сс障ゃ障罨<<吾c若若鴻(1.5.0) с紊眼篁ュc障ゃ障純若鴻潟若紊眼1.4.x с breakiterator 茘ゅサ翫с1.5.0 篏綽荀茘羔羯障 祉宴breakiterator <綽荀篋с純若鴻紊眼鴻莢紊сcс篁吟х罕篏羞隙恒荅潟障 |
3174 によって提供されるオプションよりも前に (左側に) |
4571 .LP |
3175 指定する必要があります。そうでなければ、ナビゲーションバーは |
4572 .RE |
3176 英語で表示されます。順序に依存するコマンド行オプションは、 |
4573 .TP 3 |
3177 このオプションのみです。 |
4574 \-locale\ language_country_variant |
3178 .LP |
4575 .RS 3 |
3179 .RS |
4576 .LP |
3180 .B javadoc |
4577 \f3荀\fP \- \f2\-locale\fP 激с潟罔羣箴鴻激с潟障篁篁紙箴鴻激с潟 (綏) 絎綽荀障蚊若激с潟若沿ц;腓冴障潟潟茵激с潟絎綺箴絖障 |
3181 がドキュメントを生成するときに使うロケールを指定します。 |
4578 .LP |
3182 引数には、java.util.Locale のドキュメントで説明されている |
4579 .RE |
3183 ロケールを指定します。 |
4580 .LP |
3184 たとえば、en_US (英語、米国)、en_US_WIN (Windows で使われる英語) などを |
4581 Javadoc ャ<潟篏帥宴若絎障綣違java.util.Locale ャ<潟ц宴若絎障違\f2en_US\fP (沿膠喝)\f2en_US_WIN\fP (Windows т戎沿) 絎障 |
3185 指定します。 |
4582 .LP |
3186 .LP |
4583 宴若絎絎宴若純若鴻<ゃ Javadoc c御<祉若 (蚊若激с潟若鴻茵荀冴<ゃ罨<stylesheet.css 潟<潟絖) 篏帥障障≪<純若鴻純若恰絨障ゅャ阪絖絎宴若c羆冴障障激с潟ャ<潟鴻純若鴻<ゃф絎ャ<潟若激с潟潟<潟鴻宴若羆阪с障 |
3187 ロケールを指定すると、 |
4584 .LP |
3188 .B javadoc |
4585 .TP 3 |
3189 は指定されたロケールのリソースファイルを選択して |
4586 \-encoding\ name |
3190 メッセージ (ナビゲーションバー、リストと表の見出し、 |
4587 純若鴻<ゃ潟潟若c潟違 (\f2EUCJIS/SJIS\fP ) 絎障激с潟絎翫若潟潟若帥篏帥障 |
3191 ヘルプファイルの目次、 |
4588 .LP |
3192 .BR stylesheet.css |
4589 \-docencoding \-charset с |
3193 のコメントなどの文字列) に |
4590 .LP |
3194 使います。また、アルファベット順にソートされるリストのソート順、 |
4591 .TP 3 |
3195 および最初の文の末尾を決定する文の区切り文字も、 |
4592 \-Jflag |
3196 指定したロケールによって決まります。このオプションは、 |
4593 javadoc 絎茵絎茵激鴻 java \f2flag\fP 贋・羝<障\f2J\fP \f2flag\fP 腥榊純ャ障違ャ<潟激鴻 32M ゃ<≪若腆坂鏆荀翫Java \f2\-Xmx\fP 激с潟罨<若喝冴障 \f2\-Xms\fP ュ純с <≪若泣ゃ冴荐絎激с潟с綽荀<≪若絨泣ゃ冴c翫箴水с |
3197 ドキュメント化されるクラスのソースファイル内で |
4594 .nf |
3198 指定されている doc コメントテキストの |
4595 \f3 |
3199 ロケールを決定するものではありません。 |
4596 .fl |
3200 .RE |
4597 % \fP\f3javadoc \-J\-Xmx32m \-J\-Xms32m\fP \f3com.mypackage\fP |
3201 .TP |
4598 .fl |
3202 .BI \-encoding " name" |
4599 .fi |
3203 ソースファイルのエンコーディング名 (EUCJIS/SJIS など) を指定します。 |
4600 篏睡 javadoc 若吾с潟腆肴罨< java \f2\-version\fP激с潟若喝冴障 |
3204 このオプションが指定されていない場合は、プラットフォームの |
4601 .nf |
3205 デフォルトコンバータが使われます。 |
4602 \f3 |
3206 .LP |
4603 .fl |
3207 \-docencoding および \-charset も参照してください。 |
4604 % \fP\f3javadoc \-J\-version\fP |
3208 .TP |
4605 .fl |
3209 .BI \-J flag |
4606 java version "1.2" |
3210 .BR javadoc |
4607 .fl |
3211 を実行する実行システム java に flag を直接渡します。J と flag の間に |
4608 Classic VM (build JDK\-1.2\-V, green threads, sunwjit) |
3212 空白を入れてはなりません。たとえば、生成される |
4609 .fl |
3213 ドキュメントを処理するために、システムで 32M バイトを |
4610 .fi |
3214 確保する必要がある場合は、Java の |
4611 阪鴻若罔羣若吾с括垩障障 |
3215 .B \-Xmx |
4612 .RE |
3216 オプションを次のように呼び出します。\-Xms はオプションです。初期メモリのサイズのみを設定するため、必要な最小メモリを知っている場合に便利です。 |
4613 .SS |
3217 .LP |
4614 罔羣箴激с |
3218 .RS |
4615 .LP |
3219 .ft 3 |
4616 .RS 3 |
3220 .nf |
4617 .TP 3 |
3221 % javadoc \-J\-Xmx32m \-J\-Xms32m com.mypackage |
4618 \-d\ directory |
3222 .fi |
4619 HTML <ゃ篆絖c絎障(d (destination))激с潟ャ<ゃ憜c篆絖障 \f2directory\fP 腟九障c障憜篏罐c後障c絎с障若吾с 1.4 сjavadoc 絎茵c篏障 |
3223 .ft 1 |
4620 .LP |
3224 .RE |
4621 違罨<箴с\f2com.mypackage\fP 宴若吾ャ<潟腟 \f2/home/user/doc/\fP c篆絖障 |
3225 |
4622 .nf |
3226 |
4623 \f3 |
3227 .LP |
4624 .fl |
3228 使用している javadoc のバージョンを確認するには、 |
4625 % \fP\f3javadoc \-d /home/user/doc com.mypackage\fP |
3229 次のように java の「-version」オプションを呼び出します。 |
4626 .fl |
3230 .LP |
4627 .fi |
3231 .RS |
4628 .LP |
3232 .ft 3 |
4629 .TP 3 |
3233 .nf |
4630 \-use |
3234 % javadoc -J-version |
4631 ャ<潟鴻潟宴若吾 1 ゃ [篏睡] 若吾腟粋昭帥障若吾劫鴻障宴若吾 API 篏帥c宴若吾鴻<純潟潟鴻帥潟c若荐菴違障違 C 箴 C 篏帥cC 泣鴻C 絎hc若C 菴<純潟 C <若帥ゃ<純潟潟鴻帥障 |
3235 java version "1.2" |
4632 .LP |
3236 Classic VM (build JDK-1.2-V, green threads, sunwjit) |
4633 違String [篏睡] 若吾篏茵腓冴荀帥障\f2java.awt.Font\fP 鴻 \f2getName()\fP <純\f2String\fP 菴障c\f2getName()\fP \f2String\fP 篏帥cс\f2String\fP [篏睡] 若吾<純障 |
3237 .fi |
4634 .LP |
3238 .ft 1 |
4635 ャ<潟 API 篏睡сc絎茖ャ<潟障<純絎茖筝 \f2String\fP 篏帥c綣違絖c絖菴翫\f2String\fP 篏睡帥障 |
3239 .RE |
4636 .LP |
3240 .LP |
4637 [篏睡] 若吾≪祉鴻鴻障宴若吾腱糸蚊若激с潟若 [篏睡] 潟障 |
3241 (標準ドックレットのバージョン番号は出力ストリームに表示されます。) |
4638 .TP 3 |
3242 .SS "標準ドックレットが提供するオプション" |
4639 \-version |
3243 .TP |
4640 ャ<潟@version 鴻腟粋昭帥障鴻сャ障篏睡 Javadoc 若若吾с潟腆肴\f2\-J\-version\fP 激с潟篏睡障 |
3244 .BI \-d " directory" |
4641 .LP |
3245 生成された HTML ファイルを保存するディレクトリを |
4642 .TP 3 |
3246 指定します (d は「生成先 (destination)」の意味)。このオプションを |
4643 \-author |
3247 省略すると、生成されたファイルは現在のディレクトリに保存されます。 |
4644 ャ<潟@author 鴻腟粋昭帥障 |
3248 値 |
4645 .LP |
3249 .I directory |
4646 .TP 3 |
3250 には、絶対ディレクトリまたは現在の作業 |
4647 \-splitindex |
3251 ディレクトリからの相対ディレクトリを指定できます。 |
4648 膣√<ゃ≪<茲違<ゃ蚊絖 1 ゃ<ゃ≪<篁ュ絖у障膣√潟 1 ゃ<ゃ篏障 |
3252 1.4 では、javadoc の実行時に |
4649 .LP |
3253 自動的に生成先ディレクトリが作成されます。 |
4650 .TP 3 |
3254 .LP |
4651 \-windowtitle\ title |
3255 たとえば、 |
4652 HTML <title> 帥違臀帥ゃ絎障絎帥ゃc潟帥ゃ若吾絲障篏吟若 (羂ャ) 茵腓冴障帥ゃ HTML 帥違с 帥ゃ HTML 帥違障吟帥違罩c頵iс障\f2title\fP 筝у膃篏帥翫綣膃鴻宴若綽荀障\-windowtitle ャ翫Javadoc 若激с潟篁c \-doctitle ゃ篏帥障 |
3256 次の例は、com.mypackage パッケージのドキュメントを生成し、 |
4653 .nf |
3257 結果を |
4654 \f3 |
3258 .B /home/user/doc/ |
4655 .fl |
3259 ディレクトリに保存します。 |
4656 % \fP\f3javadoc \-windowtitle "Java 2 Platform" com.mypackage\fP |
3260 .LP |
4657 .fl |
3261 .RS |
4658 .fi |
3262 .ft 3 |
4659 .TP 3 |
3263 .nf |
4660 \-doctitle\ title |
3264 % javadoc \-d /home/user/doc com.mypackage |
4661 网荀<ゃ筝菴臀帥ゃ絎障帥ゃ筝紊 1 荀冴筝蚊若激с潟若筝臀障\f2title\fP HTML 帥違腥榊純с障翫篏綣膃у蚊障違障\f2title\fP 筝у膃篏帥翫綣膃鴻宴若綽荀障 |
3265 .fi |
4662 .nf |
3266 .ft 1 |
4663 \f3 |
3267 .RE |
4664 .fl |
3268 .TP |
4665 % \fP\f3javadoc \-doctitle "Java (TM)" com.mypackage\fP |
3269 .B \-use |
4666 .fl |
3270 ドキュメント化されるクラスとパッケージごとに 1 つの [使用] ページを |
4667 .fi |
3271 含めます。このページには、ドキュメント化されるクラスまたは |
4668 .TP 3 |
3272 パッケージの API を使っているパッケージ、クラス、メソッド、 |
4669 \-title\ title |
3273 コンストラクタ、およびフィールドが記述されます。たとえば、クラス |
4670 \f3激с潟憜絖障\fPJavadoc 1.2 若睡絖障激с潟\f2\-doctitle\fP 紊眼障紊眼宴激с潟c潟帥ゃсャ<潟帥ゃ絎臂腆冴с |
3274 C およびクラス C を使うものは、C のサブクラス、C として |
4671 .LP |
3275 宣言されているフィールド、C を返すメソッド、および、型 C の |
4672 .TP 3 |
3276 パラメータを持つメソッドとコンストラクタがページに含ま |
4673 \-header\ header |
3277 れます。 |
4674 阪<ゃ筝腴臀若鴻絎障若筝蚊若激с潟若勀眼臀障\f2header\fP HTML 帥違腥榊純с障翫篏綣膃у蚊障違障\f2header\fP 筝у膃篏帥翫綣膃鴻宴若綽荀障 |
3278 .LP |
|
3279 .RS |
|
3280 たとえば、String について、[使用] ページに何が表示されるかを |
|
3281 見てみましょう。 |
|
3282 .B java.awt.Font |
|
3283 クラスの |
|
3284 .B getName() |
|
3285 メソッドは、String 型を返します。 |
|
3286 このため、 |
|
3287 .B getName() |
|
3288 は String を使うので、[使用] ページの String で |
|
3289 このメソッドを見つけることができます。 |
|
3290 .LP |
|
3291 このページでは API の使用だけがドキュメント化され、実装はドキュメント化されません。 |
|
3292 あるメソッドが実装内に String を使っているが、引数として |
|
3293 文字列をとったり、文字列を返したりしない |
|
3294 場合は、String の「使用」とはみなされません。 |
|
3295 .LP |
|
3296 生成された [使用] ページにアクセスするには、目的のクラスまたは |
|
3297 パッケージを表示して、ナビゲーションバーの [使用] リンクを |
|
3298 クリックします。 |
|
3299 .RE |
|
3300 .TP |
|
3301 .B \-version |
|
3302 生成されるドキュメントに |
|
3303 .B @version |
|
3304 テキストを含めます。このテキストは、デフォルトでは省略されます。 |
|
3305 使用している javadoc ツールのバージョンを確認するには、 |
|
3306 .B \-J\-version |
|
3307 オプションを使用します。 |
|
3308 .TP |
|
3309 .B \-author |
|
3310 生成されるドキュメントに |
|
3311 .B @author |
|
3312 テキストを含めます。 |
|
3313 .TP |
|
3314 .B \-splitindex |
|
3315 索引ファイルをアルファベットごとに複数のファイルに分割し、 |
|
3316 文字ごとに 1 つのファイルと、アルファベット以外の文字で始まる |
|
3317 索引エントリ用のファイルを 1 つ作成します。 |
|
3318 .TP |
|
3319 .BI \-windowtitle " title" |
|
3320 HTML の |
|
3321 .B <title> |
|
3322 タグで使うタイトルを指定します。指定したタイトルは、 |
|
3323 ウィンドウタイトルと、該当するページに対して作成されたブラウザの |
|
3324 ブックマーク (よくアクセスする場所) に表示されます。 |
|
3325 タイトルには HTML タグを含めないでください。タイトルに HTML タグが |
|
3326 含まれていると、ブラウザによるタグの解釈が不適切になる |
|
3327 可能性があります。 |
|
3328 .I title |
|
3329 の中で引用符を使う場合は、引用符を |
|
3330 エスケープする必要があります。 |
|
3331 .B -windowtitle |
|
3332 が省略されている場合、 |
|
3333 .B javadoc |
|
3334 ツールはこのオプションの代わりに -doctitle の値を使います。 |
|
3335 .LP |
|
3336 .RS |
|
3337 .ft 3 |
|
3338 .nf |
|
3339 % javadoc -windowtitle "Java 2 Platform" com.mypackage |
|
3340 .fi |
|
3341 .ft 1 |
|
3342 .RE |
|
3343 .TP |
|
3344 .BI \-doctitle " title" |
|
3345 概要ファイルの最上部近くに配置するタイトルを指定します。 |
|
3346 タイトルは中央揃えされ、レベル 1 の見出しとして上部 |
|
3347 ナビゲーションバーのすぐ下に置かれます。 |
|
3348 .I title |
|
3349 には、HTML タグと |
|
3350 空白を含めることができますが、これらを含める場合は全体を引用符で囲 |
|
3351 まなければなりません。 |
|
3352 .I title |
|
3353 の中で引用符を使う場合は、引用符をエスケープする必要があります。 |
|
3354 .LP |
|
3355 .RS |
|
3356 .ft 3 |
|
3357 .nf |
|
3358 % javadoc -doctitle "Java<sup><font size=\"-2\">TM</font></sup>" com.mypackage |
|
3359 .fi |
|
3360 .ft 1 |
|
3361 .RE |
|
3362 .TP |
|
3363 .BI \-title " title" |
|
3364 このオプションは、現在は存在しません。 |
|
3365 .B javadoc |
|
3366 1.2 のベータ版にだけ存在しました。このオプションは、 |
|
3367 ウィンドウタイトルではなくドキュメントタイトルを定義することを |
|
3368 明確にするため、 |
|
3369 .BR \-doctitle |
|
3370 に名前が変更されました。 |
|
3371 .TP |
|
3372 .BI \-header " header" |
|
3373 各出力ファイルの上部に配置するヘッダテキストを指定します。ヘッダは、 |
|
3374 上部ナビゲーションバーの右側に配置されます。 |
|
3375 .I header |
|
3376 には、HTML タグと |
|
3377 空白を含めることができますが、これらを含める場合は全体を引用符で |
|
3378 囲まなければなりません。header の中で引用符を使う場合は、引用符を |
|
3379 エスケープする必要があります。 |
|
3380 .nf |
4675 .nf |
3381 \f3 |
4676 \f3 |
3382 .fl |
4677 .fl |
3383 % \fP\f3javadoc \-header "<b>Java 2 Platform </b><br>v1.4" com.mypackage\fP |
4678 % \fP\f3javadoc \-header "<b>Java 2 Platform </b><br>v1.4" com.mypackage\fP |
3384 .fl |
4679 .fl |
3385 .fi |
4680 .fi |
3386 .LP |
4681 .LP |
3387 .TP |
4682 .TP 3 |
3388 .BI \-footer " footer" |
4683 \-footer\ footer |
3389 各出力ファイルの下部に配置するフッタテキストを指定します。フッタは、 |
4684 阪<ゃ筝腴臀帥若鴻絎障帥若筝蚊若激с潟若勀眼臀障 \f2footer\fP HTML 帥違腥榊純с障翫篏綣膃у蚊障違障\f2footer\fP 筝у膃篏帥翫綣膃鴻宴若綽荀障 |
3390 下部ナビゲーションバーの右側に配置されます。 |
4685 .LP |
3391 .I footer |
4686 .TP 3 |
3392 には、HTML タグと |
4687 \-bottom\ text |
3393 空白を含めることができますが、これらを含める場合は全体を引用符で |
4688 阪<ゃ筝臀鴻絎障鴻筝蚊若激с潟若筝若吾筝臀障\f2text\fP HTML 帥違腥榊純с障翫篏綣膃у蚊障違障\f2text\fP 筝у膃篏帥翫綣膃鴻宴若綽荀障 |
3394 囲まなければなりません。 |
4689 .LP |
3395 .I footer |
4690 .TP 3 |
3396 の中で引用符を使う場合は、引用符をエスケープする必要があります。 |
4691 \-link\ extdocURL |
3397 .TP |
4692 javadoc √紊с鴻ャ<潟若激с潟吾潟篏障綣違 1 ゃ障 |
3398 .BI \-bottom " text" |
4693 .LP |
3399 各出力ファイルの最下部に配置するテキストを指定します。 |
4694 .RS 3 |
3400 このテキストは、下部ナビゲーションバーの下のページの最下部に |
4695 .TP 2 |
3401 配置されます。 |
4696 o |
3402 .I text |
4697 \f4extdocURL\fP 潟絎javadoc c紊ャ<潟c腟九 URL 障後 URL ст腓冴障c宴若吾鴻<ゃ絖違障 絖翫\f2\-linkoffline\fP 篏睡障Javadoc 若\f2宴若吾鴻\fP<ゃ宴若後茯水宴若吾 URL 潟障Javadoc 若絎茵篏 \f2<A HREF>\fP 潟 \f2extdocURL\fP ゃ障障潟若障c\f2extdocURL\fP <ゃ吾 URL сc吾 URLс違障 |
3403 には、HTML タグと空白を含めることができますが、 |
4698 .LP |
3404 これらを含める場合は全体を引用符で囲まなければなりません。 |
4699 \f2extdocURL\fP 吾腟九障潟篏睡若吟若ャ<潟篁紙 Web 泣ゃ筝ャ<潟潟с障 後鞘臀吾潟с翫後障潟篏睡с障後障潟篏睡翫\f2\-d\fP 篏帥cc潟宴若吾c後障鴻絎綽荀障 |
3405 .I text |
4700 .LP |
3406 の中で引用符を使う場合は、引用符をエスケープする必要があります。 |
4701 絽吾腟九障潟絎翫\f2http:\fP潟篏睡障Web 泣若若<ゃ激鴻潟翫\f2file:\fP 潟篏睡с障号鴻若吟若<ゃ激鴻掩ャ<潟≪祉鴻綽荀翫篁ュ篏睡с |
3407 .TP |
4702 .LP |
3408 .BI \-link " extdocURL" |
4703 翫若c潟違激鴻с腟九 URL 後 URL http:若鴻file:若鴻鴻激ャ阪絖篏睡障 ( |
3409 .B javadoc |
|
3410 ツールにより生成された既存の |
|
3411 外部参照クラスのドキュメンテーションへのリンクを作成します。 |
|
3412 引数は 1 つです。 |
|
3413 .TP |
|
3414 \(bu |
|
3415 .I extdocURL |
|
3416 は、javadoc によって生成され、リンク先として指定する |
|
3417 外部ドキュメントがあるディレクトリの絶対 URL または相対 URL です。 あとで例を示します。 このディレクトリ内に package-list ファイルが存在して |
|
3418 いなければなりません。存在しない場合は、\-linkoffline を使用します。 |
|
3419 .B javadoc |
|
3420 ツールは package-list ファイルからパッケージ名を読み取り、それを |
|
3421 .I extdocURL |
|
3422 のパッケージにリンクします。 javadoc ツールを実行すると、 |
|
3423 .I extdocURL |
|
3424 値は作成された <A HREF> リンクにそのままコピーされます。 したがって、 |
|
3425 .I extdocURL |
|
3426 はファイルではなく、 |
|
3427 .I extdocURL |
|
3428 の URL である必要があります。 |
|
3429 .LP |
|
3430 ドキュメントを任意の Web サイト上のドキュメントにリンクするには |
|
3431 .I extdocURL |
|
3432 の絶対リンクを、相対ロケーションだけを指定するには |
|
3433 相対リンクを使用できます。相対リンクを使用する場合、生成先ディレクトリ (\-d で指定) からの相対パスを、 |
|
3434 リンク先パッケージがあるディレクトリに渡す必要があります。 |
|
3435 .LP |
|
3436 通常、絶対リンクを指定する場合は、http: リンクを使用します。 |
|
3437 ただし、Web サーバをもたないファイルシステムに |
|
3438 リンクする場合は、file: リンクを使用できます。 |
|
3439 ただし、この方法は、生成されたドキュメントに |
|
3440 アクセスしようとする |
|
3441 すべてのユーザが同じファイルシステムを共有している |
|
3442 場合以外は使用しないでください。 |
|
3443 .LP |
|
3444 すべての場合、すべてのオペレーティングシステムで、絶対 URL と相対 URL、「http:」ベースと「file:」ベースにかかわらず、スラッシュを区切り文字として使用します |
|
3445 .fi |
|
3446 (http://www.ietf.org/rfc/rfc1738.txt |
|
3447 の |
|
3448 .na |
4704 .na |
3449 \f2URL Memo\fP で指定)。 |
4705 \f2URL Memo\fP @ |
3450 .RS 3 |
4706 .fi |
3451 .TP 3 |
4707 http://www.ietf.org/rfc/rfc1738.txt ф絎) |
3452 http: ベースの絶対リンク: |
4708 .RS 3 |
|
4709 .TP 3 |
|
4710 http:若鴻腟九障潟: |
3453 \f2\-link http://<host>/<directory>/<directory>/.../<name>\fP |
4711 \f2\-link http://<host>/<directory>/<directory>/.../<name>\fP |
3454 .TP 3 |
4712 .TP 3 |
3455 file: ベースの絶対リンク: |
4713 file:若鴻腟九障潟: |
3456 \f2\-link file://<host>/<directory>/<directory>/.../<name>\fP |
4714 \f2\-link file://<host>/<directory>/<directory>/.../<name>\fP |
3457 .TP 3 |
4715 .TP 3 |
3458 相対リンク: |
4716 後障潟: |
3459 \f2\-link <directory>/<directory>/.../<name>\fP |
4717 \f2\-link <directory>/<directory>/.../<name>\fP |
3460 .RE |
4718 .RE |
3461 .RE |
4719 .RE |
3462 .LP |
4720 .LP |
3463 javadoc 実行時に複数の \-link オプションを指定して、 |
4721 javadoc 絎茵茲違 \f2\-link\fP 激с潟絎茲違ャ<潟吾潟篏с障 \f3\-linkoffline 障 \-link 御\fP |
3464 複数のドキュメントへのリンクを作成することもできます。 |
4722 .br |
3465 .LP |
4723 \f2\-link\fP 篏睡翫: |
3466 \-linkoffline または \-link の選択 |
4724 .RS 3 |
3467 .LP |
4725 .TP 2 |
3468 \-link を使用する場合: |
4726 o |
3469 .TP 3 |
4727 紊 API ャ<潟吾後障鴻篏睡翫 |
3470 \(bu |
4728 .TP 2 |
3471 外部 API ドキュメントへの相対パスを使用している |
4729 o |
3472 .TP 3 |
4730 紊 API ャ<潟吾腟九 URL 篏睡翫 (違 URL ・膓茯水茵激сc荐怨翫) |
3473 \(bu |
4731 .RE |
3474 外部 API ドキュメントへの絶対 URL を使用している (プログラムがその URL に接続し、読み取りを行うことが |
4732 罨<翫\f2\-linkoffline\fP 激с潟篏睡障 |
3475 シェルによって許可されている場合) |
4733 .RS 3 |
3476 .LP |
4734 .TP 2 |
3477 \-linkoffline を使用する場合: |
4735 o |
3478 .TP 3 |
4736 違 URL ・膓茯水茵激сc荐怨翫紊 API ャ<潟吾腟九 URL 篏睡翫倶潟ャ<潟<ゃ≪若眼翫榊障 |
3479 \(bu |
4737 .RE |
3480 外部 API ドキュメントへの絶対 URL を使用している |
4738 .LP |
3481 (プログラムがその URL に接続し、読み取りを行うことが |
4739 \f3紊ャ<潟吾腟九障潟篏睡箴\fP \- |
3482 シェルによって許可されていない場合)。このような状況は、 |
4740 .na |
3483 リンク先のドキュメントがファイアウォールの |
4741 \f2http://java.sun.com/j2se/1.5.0/docs/api\fP @ |
3484 向こう側にある場合に発生します。 |
4742 .fi |
3485 .LP |
4743 http://java.sun.com/j2se/1.5.0/docs/api \f2java.lang\fP\f2java.io\fP篁 Java 2 若宴若吾潟翫障 罨<潟潟\f2com.mypackage\fP 宴若吾ャ<潟 Java 2 若宴若吾吾潟障ャ<潟違鴻弱 \f2Object\fP 鴻吾潟障障\f2\-sourcepath\fP \f2\-d\fP 篁激с潟茵腓冴障 |
3486 外部ドキュメントへの絶対リンクの使用例 - |
4744 .nf |
3487 java.lang、java.io、および他の Java 2 プラットフォームパッケージ |
4745 \f3 |
3488 (\f2http://java.sun.com/j2se/1.5.0/docs/api\fP) に |
4746 .fl |
3489 リンクしたい場合があります。 |
4747 % \fP\f3javadoc \-link http://java.sun.com/j2se/1.5.0/docs/api com.mypackage\fP |
3490 次のコマンドは、 |
4748 .fl |
3491 Java 2 プラットフォームパッケージへのリンクを持つ |
4749 .fi |
3492 com.mypackage パッケージのドキュメントを生成します。 |
4750 \f3紊ャ<潟吾後障潟篏睡箴\fP \- 2 ゃ宴若吾ャ<潟 Javadoc 若茲医絎茵腟с障 ャ<潟後障鴻у蚊障箴翫2 ゃ宴若吾API с \f2com.apipackage\fP SPI (泣若鴻ゃゃ潟帥с若) с \f2com.spipackage\fP сャ<潟主 \f2docs/api/com/apipackage\fP 宴若吾 \f2docs/spi/com/spipackage\fP 宴若吾сAPI 宴若吾ャ<潟с憜c \f2docs\fP с翫罨<潟潟絎茵c API ャ<潟吾潟 SPI 宴若吾ャ<潟障 |
3493 生成されたドキュメントには、たとえばクラスツリー内の |
4751 .nf |
3494 Object クラスへのリンクが含まれています |
4752 \f3 |
3495 (\-sourcepath や \-d などの他のオプションは表示されません)。 |
4753 .fl |
3496 .LP |
4754 % \fP\f3javadoc \-d ./spi \-link ../api com.spipackage\fP |
3497 .RS |
4755 .fl |
3498 .ft 3 |
4756 .fi |
3499 .nf |
4757 .LP |
3500 % \fP\f3javadoc \-link http://java.sun.com/j2se/1.5.0/docs/api com.mypackage\fP |
4758 \f2\-link\fP 綣違c (\f2docs/spi\fP) 後障鴻с |
3501 .fi |
4759 .LP |
3502 .ft 1 |
4760 \f3荅括完\fP \- \f2\-link\fP 激с潟篏帥潟若сJavadoc 篁絎茵сャ<潟鴻潟с障潟鴻若吾腱糸с HTML 若吾贋茯帥鴻贋 \f2extdocURL\fP 絎綽荀障激с潟篏帥違泣若若c若ャ<潟\f2http://java.sun.com\fP \f2java.*\fP ャ<潟潟с障 |
3503 .RE |
4761 .LP |
3504 .LP |
4762 篁絎茵 Javadoc cャ<潟 API 絲乗院潟篏翫\f2\-link\fP 激с潟ャ障\f2\-link\fP 激с潟絎翫Javadoc 若紊сャ<潟吾潟篏障ャ<潟絖喝翫贋ゅャсс |
3505 外部 ドキュメントへの相対リンクの使用例 - |
4763 .LP |
3506 .B javadoc |
4764 激с潟сャ<潟茲違贋潟篏с障 |
3507 ツールの異なる実行で生成されたドキュメントを持つ |
4765 .LP |
3508 2 つのパッケージがあり、それらが別々の |
4766 障激с潟篏帥茲違宴若悟召鴻潟篏с障ゃ障筝綣宴若吾絲障 javadoc 絎茵ャ筝綣宴若吾絲障 javadoc 絎茵 2 ゃ宴若悟召鴻潟篏с障 |
3509 相対パスをもっているとします。 |
4767 .LP |
3510 この例では、2 つのパッケージを |
4768 \f3鴻ф号\fP \- 紊с鴻吾潟鴻с鎘茵腓冴罨<号с鴻с綽荀障<純篏с鴻ссс障\f2import\fP 障絎hус綽荀障罨< \f2java.io.File\fP с号箴腓冴障 |
3511 com.apipackage (API)、com.spipackage |
4769 .RS 3 |
3512 (SPI - Service Provide Interface) とします。 ドキュメントの置き場所は docs/api/com/apipackage および |
4770 .TP 2 |
3513 docs/spi/com/spipackage です。 |
4771 o |
3514 API パッケージドキュメントはすでに生成され、ドキュメントが現在の |
4772 鴻腮蕁 \f2import\fP 翫: ゃ若ゃ潟若腓榊ゃ潟若障 \f2java.lang.*\fP 絲障ゃ潟若違罨<医с |
3515 ディレクトリ内にある場合、次のように実行することで、 |
|
3516 API ドキュメントにリンクした SPI パッケージをドキュメント化できます。 |
|
3517 .LP |
|
3518 .RS |
|
3519 .ft 3 |
|
3520 .nf |
|
3521 % javadoc \-d ./spi \-link ../api com.spipackage |
|
3522 .fi |
|
3523 .ft 1 |
|
3524 .RE |
|
3525 .LP |
|
3526 \-link 引数が生成先ディレクトリの相対パス (docs/spi) で |
|
3527 あることに注意してください。 |
|
3528 .LP |
|
3529 詳細 - |
|
3530 \-link オプションを使うと、コードからは参照されていても、 |
|
3531 Javadoc の現在の実行ではドキュメント化されないクラスにリンク |
|
3532 できるようになります。 リンクから有効なページに |
|
3533 移動できるようにするには、それらの HTML ページが |
|
3534 ある場所を調べ、その場所を |
|
3535 .I extdocURL |
|
3536 に指定する必要があります。 |
|
3537 このオプションを使うと、たとえば、サードパーティのドキュメントから、 |
|
3538 http://java.sun.com にある java.* のドキュメントにリンクすることができます。 |
|
3539 .LP |
|
3540 今回の実行で |
|
3541 .B javadoc |
|
3542 によって生成されるドキュメント内の |
|
3543 API だけを対象にリンクを作成する場合は、 |
|
3544 \-link オプションを省略します。 \-link オプションが |
|
3545 指定されていない場合、 |
|
3546 .B javadoc |
|
3547 ツールは、外部参照されたドキュメントへのリンクを |
|
3548 作成しません。これは、そのドキュメントが |
|
3549 存在するかどうか、あるいは存在していてもどこに |
|
3550 存在しているのかを判別できないからです。 |
|
3551 .LP |
|
3552 このオプションは、生成ドキュメント内の複数の場所に |
|
3553 リンクを作成できます。 |
|
3554 .LP |
|
3555 また、このオプションを使うと、複数のパッケージ群の間にクロスリンクを作成することもできます。つまり、ある一式のパッケージに対して javadoc を実行したあと、別の一式のパッケージに対して javadoc を実行し、これら 2 つのパッケージ群の間にクロスリンクを作成できます。 |
|
3556 .LP |
|
3557 \f3クラスの参照方法\fP - 外部参照クラスへのリンクを、テキストラベルだけではなく実際に表示するには、次の方法でクラスを参照する必要があります。メソッドの本体でクラスを参照するだけでは十分ではありません。\f2import\fP 文または宣言で参照する必要があります。次に、クラス \f2java.io.File\fP を参照する方法の例を示します。 |
|
3558 .RS 3 |
|
3559 .TP 2 |
|
3560 o |
|
3561 すべての種類の \f2import\fP 文の場合: ワイルドカードによるインポート、名前による明示的なインポート、または \f2java.lang.*\fP に対する自動的なインポート。たとえば、次のようにすれば十分です。 |
|
3562 .br |
4773 .br |
3563 \f2import java.io.*;\fP |
4774 \f2import java.io.*;\fP |
3564 .br |
4775 .br |
3565 1.3.x および 1.2.x では、名前による明示的なインポートだけです。ワイルドカードによるインポート文も、自動インポート \f2java.lang.*\fP も使用できません。 |
4776 1.3.x 1.2.x с腓榊ゃ潟若сゃ若ゃ潟若ゃ潟若 \f2java.lang.*\fP 篏睡с障 |
3566 .TP 2 |
4777 .TP 2 |
3567 o |
4778 o |
3568 宣言の場合: |
4779 絎h翫: |
3569 .br |
4780 .br |
3570 \f2void foo(File f) {}\fP |
4781 \f2void foo(File f) {}\fP |
3571 .br |
4782 .br |
3572 この参照を使用し、メソッド、コンストラクタ、フィールド、クラス、またはインタフェースのリターンタイプまたはパラメータタイプに置くか、\f2implements\fP、\f2extends\fP、または \f2throws\fP 文に置きます。 |
4783 с篏睡<純潟潟鴻帥c若鴻障ゃ潟帥с若鴻祉ゃ障<若帥臀\f2implements\fP\f2extends\fP障 \f2throws\fP 臀障 |
3573 .RE |
4784 .RE |
3574 .LP |
4785 .LP |
3575 この結果、\f2\-link\fP オプションを使用しても、この制限のために誤って表示されない多くのリンクが多数発生する可能性があります。テキストはハイパーテキストリンクが付けられずに表示されます。これらのリンクが表示する警告から、このリンクを認識できます。クラスを正しく参照し、それによってリンクを追加するためのもっとも安全な方法は上で説明したとおり、当該のクラスをインポートすることです。 |
4786 腟\f2\-link\fP 激с潟篏睡狗茯ゃc茵腓冴紊潟紊亥榊醇с障鴻ゃ若鴻潟篁茵腓冴障潟茵腓冴茘潟茯茘с障鴻罩cсc潟菴遵c絎号筝ц綵荅蚊鴻ゃ潟若с |
3576 .LP |
4787 .LP |
3577 .B パッケージリスト: |
4788 \f3宴若吾鴻\fP \- \f2\-link\fP 激с潟\f2package\-list\fP <ゃ荀羆障 <ゃJavadoc 若c\f2\-link\fP c絎 URL 絖障\f2package\-list\fP <ゃ贋ャ<潟宴若吾鴻ャc膣鴻<ゃс箴сJavadoc 若絎 URL \f2package\-list\fP <ゃ「宴若後茯粋昭с URL 宴若吾吾潟篏障 |
3578 .B \-link |
4789 .LP |
3579 オプションでは、javadoc ツールによって生成された |
4790 違Java 若 v5.0 API 宴若吾鴻 |
3580 .BR package-list |
|
3581 という名前のファイルが、このオプションで指定する URL に存在している |
|
3582 必要があります。 |
|
3583 .BR package-list |
|
3584 ファイルは、その場所でドキュメント化されているパッケージの |
|
3585 名前のリストを含む単純なテキストファイルです。 |
|
3586 前の例では、 |
|
3587 .B javadoc |
|
3588 ツールは、指定された URL にある |
|
3589 .BR package-list |
|
3590 という名前のファイルを探し、パッケージ名を読み込んで、 |
|
3591 その URL にあるそれらのパッケージへのリンクを作成しました。 |
|
3592 .LP |
|
3593 たとえば、Java プラットフォーム v5.0 API のパッケージリストは以下にあり、 |
|
3594 .na |
4791 .na |
3595 \f2http://java.sun.com/j2se/1.5.0/docs/api/package\-list\fP |
4792 \f2http://java.sun.com/j2se/1.5.0/docs/api/package\-list\fP @ |
3596 .RE |
4793 .fi |
3597 .LP |
4794 http://java.sun.com/j2se/1.5.0/docs/api/package\-list 罨<絎鴻у障c障 |
3598 次のような内容で始まっています。 |
4795 .nf |
3599 .LP |
4796 \f3 |
3600 .RS |
4797 .fl |
3601 .ft 3 |
4798 java.applet |
3602 .nf |
4799 .fl |
3603 java.applet |
4800 java.awt |
3604 java.awt |
4801 .fl |
3605 java.awt.color |
4802 java.awt.color |
3606 java.awt.datatransfer |
4803 .fl |
3607 java.awt.dnd |
4804 java.awt.datatransfer |
3608 java.awt.event |
4805 .fl |
3609 java.awt.font |
4806 java.awt.dnd |
3610 その他 ... |
4807 .fl |
3611 .fi |
4808 java.awt.event |
3612 .ft 1 |
4809 .fl |
3613 .RE |
4810 java.awt.font |
3614 .LP |
4811 .fl |
3615 .B \-link |
4812 篁 ... |
3616 オプションを指定せずに |
4813 .fl |
3617 .B javadoc |
4814 \fP |
3618 ツールを実行した場合、ドキュメントの生成時に外部参照 |
4815 .fi |
3619 クラスに属する名前を |
4816 .LP |
3620 見つけると、 |
4817 \f2\-link\fP 激с潟絎 javadoc 絎茵翫紊с鴻絮荀ゃjavadoc 潟綵≪у阪障筝鴻\f2\-link\fP 激с潟絎翫絎 \f2extdocURL\fP \f2package\-list\fP <ゃ荅峨宴若後罎膣≪障宴若後荀ゃ\f2extdocURL\fP 篁障 |
3621 .B javadoc |
4818 .LP |
3622 はその名前をリンクを持たない形で出力します。一方、 |
4819 鴻潟罩c閟純紊с鴻ャ<潟絎 URL 絖違障Javadoc 若絎 package\-list 絖茯帥鴻с絎 URL 若吾絖с障 |
3623 .B \-link |
4820 .LP |
3624 オプションが指定されている場合、 |
4821 \f3茲違潟\fP \- 茲違 \f2\-link\fP 激с潟絎篁紙違紊ャ<潟絲障潟荐絎с障Javadoc 1.2 茲違 \f2\-link\fP 激с潟絎с違障 1.2.2 т信罩c障 |
3625 .B javadoc |
4822 .LP |
3626 ツールは、指定された |
4823 潟紊ャ<潟罨<ャ潟激с潟絎障 |
3627 .IR extdocURL |
4824 .LP |
3628 の場所にある |
4825 \ \ \f2% \fP\f4javadoc \-link\fP \f2extdocURL1\fP \f4\-link\fP \f2extdocURL2\fP \f2...\fP\f4\-link\fP \f2extdocURLn\fP \f4com.mypackage\fP |
3629 .B package-list |
4826 .LP |
3630 ファイルから、該当する名前のパッケージを探します。パッケージ名が |
4827 \f2extdocURL1\fP\f2extdocURL2\fP... \f2extdocURLn\fP 紊ャ<潟若若 \f2package\-list\fP <ゃャc障 |
3631 見つかった場合は、その |
4828 .LP |
3632 .IR extdocURL |
4829 \f3鴻潟\fP \- 障 2 や札筝ャ<潟鴻潟翫若鴻綽荀障ゃ障ャ<潟ゃ \f2package\-list\fP 絖翫ャ<潟絲障 javadoc 若絎茵鴻с2 ャ<潟 \f2package\-list\fP 障絖障c紊潟篏2 ャ<潟сャ<潟眼綽荀障 |
3633 を名前の前に付けます。 |
4830 .LP |
3634 .LP |
4831 翫ャ<潟ャ<潟 \f2package\-list\fP 篏с 宴若後鴻<翫package\-list тс障罨<2 ャ<潟紊潟障綽荀紊 \f2package\-list\fP <ゃ絖翫Javadoc 若茘茵腓冴障 |
3635 すべてのリンクが正しく機能するためには、外部参照の |
4832 .LP |
3636 ドキュメントのすべてが、指定された URL に |
4833 .TP 3 |
3637 存在していなければなりません。 |
4834 \-linkoffline\ extdocURL\ packagelistLoc |
3638 .B javadoc |
4835 激с潟\f2\-link\fP 激с潟紊с <javadoc c紊с鴻ャ<潟吾潟篏障Javadoc 若篏ゃ潟c (Web ・膓篏帥cャ<潟≪祉鴻с)Web 筝ャ<潟潟\f2\-linkoffline\fP 激с潟篏睡障 |
3639 ツールは、 |
4836 .LP |
3640 .B package-list |
4837 ウ絲紊ャ<潟 \f2package\-list\fP <ゃ≪祉鴻с障<ゃ \f2extdocURL\fP ф絎贋違贋 (絽吾\f2packageListLoc\fP ф絎純若贋) 絖\f2\-linkoffline\fP 篏睡障c\f2extdocURL\fP WWW 筝с≪祉鴻с翫\f2\-linkoffline\fP 絎ャ<潟 javadoc 若 Web ・膓с違句障 |
3641 が存在するかどうかを調べるだけで、指定された URL に |
4838 .LP |
3642 目的のページが存在するかどうかはチェックしません。 |
4839 ャ<潟贋違潟違篏睡純с宴若吾祉篏絲障 javadoc 絎茵紊眼筝宴若吾絲障 javadoc 絎茵障 贋違<ゃ吾<ゃ祉水ャс障箴хず障 |
3643 .LP |
4840 .LP |
3644 .B 複数のリンク: |
4841 \f2\-linkoffline\fP 激с潟綣違 2 ゅ障 綣違 \f2<a href>\fP 潟腟粋昭障絖絎綣違2 綣違 \f2package\-list\fP 罎膣√贋絎綣違с |
3645 複数の |
4842 .RS 3 |
3646 .B \-link |
4843 .TP 2 |
3647 オプションを提供して、外部で生成されたドキュメントに任意数のリンクを設定できます。Javadoc 1.2 には、複数の |
4844 o |
3648 .B -link |
4845 \f4extdocURL\fP 潟絎javadoc c紊ャ<潟c腟九 URL 障後 URL с後障潟篏睡翫\f2\-d\fP 篏帥cc潟宴若吾若後障鴻絎綽荀障荅括完\f2\-link\fP 激с潟 \f2extdocURL\fP с |
3649 コマンドを提供できないというバグがあります。このバグは、 |
4846 .TP 2 |
3650 1.2.2 で修正されました。 |
4847 o |
3651 .LP |
4848 \f4packagelistLoc\fP 紊ャ<潟 \f2package\-list\fP <ゃャcc鴻障 URL 絎障URL (http: 障 file:)or file:)<ゃ鴻<с障障障腟九障鴻後障鴻<с絎с障後障鴻翫javadoc 絎茵潟c後障鴻絎障\f2package\-list\fP <ゃс |
3652 リンクする外部ドキュメントごとに別のリンクオプションを指定します。 |
4849 .RE |
3653 .LP |
4850 .LP |
3654 .RS |
4851 javadoc 1 絎茵с茲違 \f2\-linkoffline\fP 激с潟絎с障1.2.2 茲違激с潟絎с障с |
3655 .ft 3 |
4852 .LP |
3656 .nf |
4853 \f3紊ャ<潟吾腟九障潟篏帥c箴\fP \- \f2http://java.sun.com/j2se/1.5.0/docs/api\fP \f2java.lang\fP\f2java.io\fP潟篁 Java 2 若宴若吾潟Web ≪祉鴻с 翫ゃ帥障翫吟 |
3657 % javadoc \-link extdocURL1 \-link extdocURL2 ... \-link extdocURLn com.mypackage |
4854 .na |
3658 .fi |
4855 \f2http://java.sun.com/j2se/1.5.0/docs/api/package\-list\fP @ |
3659 .ft 1 |
4856 .fi |
3660 .RE |
4857 http://java.sun.com/j2se/1.5.0/docs/api/package\-list \f2package\-list\fP <ゃ若c篆絖障 2 綣 \f2packagelistLoc\fP 若潟若贋絎障箴с宴若吾鴻<ゃ潟c "\f2.\fP" 篆絖障罨<潟潟Java 2 若 API 吾潟\f2com.mypackage\fP 宴若吾ャ<潟障ャ<潟違鴻弱 \f2Object\fP 鴻吾潟障障\f2\-sourcepath\fP 篁綽荀激с潟茵腓冴障 |
3661 .LP |
4858 .nf |
3662 .BR extdocURL1、 |
4859 \f3 |
3663 .BR extdocURL2、... |
4860 .fl |
3664 .BR extdocURLn |
|
3665 は、それぞれ外部ドキュメントの |
|
3666 ルートを指し、各ルートには、 |
|
3667 .BR package-list |
|
3668 という名前のファイルが含まれています。 |
|
3669 .LP |
|
3670 クロスリンク - まだ生成されていない 2 つ以上のドキュメントを |
|
3671 クロスリンクする場合は、「ブートストラッピング」が必要になることに |
|
3672 注意してください。言い換えると、どのドキュメントの |
|
3673 .B package-list |
|
3674 も存在していない場合、最初のドキュメントに対して |
|
3675 .B javadoc |
|
3676 ツールを実行した時点では、2 番目のドキュメントの |
|
3677 .B package-list |
|
3678 はまだ存在していません。したがって、外部リンクを作成するには、 |
|
3679 2 番目のドキュメントを |
|
3680 生成したあと、最初のドキュメントを生成し直す必要があります。 |
|
3681 .LP |
|
3682 この場合、最初に行うドキュメント生成の目的は、 |
|
3683 .B package-list |
|
3684 を作成することです。パッケージ名をすべて把握している場合は、 |
|
3685 .B package-list |
|
3686 を手動で作成することもできます。次に、2 番目のドキュメントと |
|
3687 その外部リンクを生成します。 |
|
3688 .B javadoc |
|
3689 ツールは、必要な外部の |
|
3690 .B package-list |
|
3691 ファイルが存在しない場合は、警告を表示します。 |
|
3692 .TP |
|
3693 .BI \-linkoffline " extdocURL packagelistLoc" |
|
3694 このオプションは、 |
|
3695 .BR \-link |
|
3696 オプションを変えたものです。どちらも、javadoc で |
|
3697 生成された外部参照クラスのドキュメントへのリンクを作成します。 |
|
3698 .B Javadoc |
|
3699 ツールが「オフライン」で、Web 上のドキュメントに |
|
3700 リンクする場合は、Web 接続経由ではドキュメントに |
|
3701 アクセスできないため、 |
|
3702 .B \-linkoffline |
|
3703 オプションを使用します。 |
|
3704 .LP |
|
3705 厳密には、外部ドキュメントの \f2package\-list\fP ファイルにアクセスできないとき、またはこのファイルが \f2extdocURL\fP で指定された場所とは異なる場所 (通常、\f2packageListLoc\fP で指定可能なローカルな場所) に存在するとき、\f2\-linkoffline\fP を使用します。したがって、\f2extdocURL\fP に WWW 上でしかアクセスできない場合は、\f2\-linkoffline\fP を指定することにより、ドキュメントの生成時に javadoc ツールが Web に接続できなければならないという制約がなくなります。 |
|
3706 .LP |
|
3707 さらに、ドキュメントを更新するための「ハッキング」としての使用も可能です。パッケージのセット全体に対して javadoc を実行したあと、変更した一部のパッケージだけに対して javadoc を実行します。こうして、更新されたファイルを、オリジナルのファイルセットに挿入できるようにします。例をあとで示します。 |
|
3708 .LP |
|
3709 .BR \-linkoffline |
|
3710 オプションには 2 つの引数があります。1 つは |
|
3711 <a href> リンクに埋め込む文字列、もう 1 つは |
|
3712 .BR package-list: |
|
3713 の検索場所を示します。 |
|
3714 .LP |
|
3715 .RS |
|
3716 .TP 2 |
|
3717 \(bu |
|
3718 .I extdocURL |
|
3719 は、\f3javadoc\f1 によって生成され、リンク先として指定する |
|
3720 外部ドキュメントがあるディレクトリの絶対 |
|
3721 URL または相対 URL です。 相対リンクの場合、 |
|
3722 生成先ディレクトリ (\-d で指定) からの相対パスを、 |
|
3723 リンク先パッケージのルートに渡す必要があります。 詳細は、 |
|
3724 .B \-link |
|
3725 オプションの |
|
3726 .I extdocURL |
|
3727 を参照してください。 |
|
3728 .TP 2 |
|
3729 \(bu |
|
3730 .I packagelistLoc |
|
3731 には、外部ドキュメントの |
|
3732 .B package-list |
|
3733 ファイルが入っているディレクトリのパスまたは |
|
3734 URL を指定します。 URL (http: または file:) |
|
3735 またはファイルパスを指定できます。 |
|
3736 また、絶対パスと相対パスのどちらでもかまいません。 |
|
3737 相対パスの場合は、javadoc が実行される現在の |
|
3738 ディレクトリからの相対パスとして指定します。 |
|
3739 .BR package-list |
|
3740 というファイル名は含めないでください。 |
|
3741 .LP |
|
3742 .B javadoc |
|
3743 の 1 回の実行で、複数の |
|
3744 .B \-linkoffline |
|
3745 オプションを指定できます。 |
|
3746 1.2.2 より前のバージョンでは、複数のオプションは指定できませんでした。 |
|
3747 .LP |
|
3748 外部ドキュメントへの絶対リンクを使った例 - |
|
3749 .BR java.lang |
|
3750 、 |
|
3751 .BR java.io |
|
3752 、およびその他の Java 2 プラットフォームパッケージ (\f2http://java.sun.com/j2se/1.5.0/docs/api\fP) |
|
3753 にリンクしたくても、Web にアクセスできない |
|
3754 場合について考えてみます。 |
|
3755 .BR package-list |
|
3756 ファイルをブラウザで開き (\f2http://java.sun.com/j2se/1.5.0/docs/api/package\-list\fP)、 |
|
3757 ローカルディレクトリに保存します。 |
|
3758 次に、2 番目の引数 |
|
3759 .I packagelistLoc |
|
3760 でそのローカルコピーを指定します。このとき |
|
3761 パッケージリストファイルは現在のディレクトリ |
|
3762 「.」に保存されています。 次のコマンドは、 |
|
3763 Java 2 プラットフォームパッケージへのリンクを含む、 |
|
3764 com.mypackage パッケージのドキュメントを生成します。 |
|
3765 生成されたドキュメントには、たとえばクラスツリー内の |
|
3766 Object クラスへのリンクが含まれています |
|
3767 (\-sourcepath などの他の必要なオプションは表示されません)。 |
|
3768 .LP |
|
3769 .RS |
|
3770 .ft 3 |
|
3771 .nf |
|
3772 % \fP\f3javadoc \-linkoffline http://java.sun.com/j2se/1.5.0/docs/api . com.mypackage\fP |
4861 % \fP\f3javadoc \-linkoffline http://java.sun.com/j2se/1.5.0/docs/api . com.mypackage\fP |
3773 .fi |
4862 .fl |
3774 .ft 1 |
4863 .fi |
3775 .RE |
4864 .LP |
3776 .LP |
4865 \f3紊ャ<潟吾後障潟篏睡箴\fP \- 絽吾\f2\-linkoffline\fP 後障鴻絎障 \f2\-link\fP усс\f2\-linkoffline\fP 篏睡\f2package\-list\fP 絽吾若<ゃ絎障 後障潟篏睡潟<ゃ絽吾若<ゃ絎障c\f2\-linkoffline\fP 2 ゃ綣違ャ鴻絎綽荀障2 ゃ綣違筝с翫\f2\-link\fP 篏睡с障\f2\-link\fP 後障潟箴с |
3777 外部ドキュメントへの相対リンクを使った例 - |
4866 .LP |
3778 .B \-linkoffline |
4867 \f4package\-list\fP\f3 <ゃт\fP \- \f2package\-list\fP <ゃ障絖ャ<潟潟宴若後c翫<ゃт\f2packagelistLoc\fP с鴻絎с障\f2com.apipackage\fP \f2com.spipackage\fP 宴若吾鴻絖冴箴с号宴若後c障違紊ャ<潟潟ャ<潟綽荀翫箴水с障\f2package\-list\fP <ゃ Javadoc 1.0 1.1 х宴若後 \f2package\-list\fP <ゃ篏号障罕2 ゃ篌腓障 \f2package\-list\fP <ゃ掩с鴻潟荐絎ャ<潟若鴻純с |
3779 を相対パスで指定するのはあまり一般的ではありません。通常は、 |
4868 .LP |
3780 .B \-link |
4869 \f3茲違ャ<潟吾潟\fP \- \f2\-linkoffline\fP уャ<潟 1 ゃゆ絎障 罨<箴с激с潟茵障 |
3781 で十分だからです。 |
4870 .LP |
3782 .B \-linkoffline |
4871 \f2% \fP\f4javadoc \-linkoffline\fP \f2extdocURL1\fP \f2packagelistLoc1\fP \f2\\\fP |
3783 を使用している場合、 |
4872 .br |
3784 .BR package-list |
4873 \f2\ \ \ \ \ \ \ \ \ \ \fP\f4\-linkoffline\fP \f2extdocURL2\fP \f2packagelistLoc2\fP \f2\\\fP |
3785 ファイルは通常ローカルで、相対リンクを使用している場合は、 |
4874 .br |
3786 リンク先のファイルもローカルであるのが普通です。 |
4875 \f2\ \ \ \ \ \ \ \ \ \ ...\fP |
3787 そのため、 |
4876 .LP |
3788 .B \-linkoffline |
4877 \f3ャ<潟贋\fP \- 菴違 \f2\-linkoffline\fP 激с潟蚊ゃ吾с紊ч宴若吾障с弱篏絲障 javadoc 絎茵絎篋翫罨<絎茵с絨紊眼純若鴻若鋇絲障 javadoc 絎茵翫箴水сャ<潟若激с潟潟<潟絲障紊眼絎h紊眼翫炊cс潟違с純若鴻潟若絎h菴遵ゃ障紊眼翫膣√宴若吾若膓帥<潟若鴻[篏睡] 若吾贋с潟紕障 |
3789 に 2 つの異なる引数のパスを |
4878 .LP |
3790 与える必要はありません。 2 つの引数が同じである場合、 |
4879 障篁絎茵т戎違c (\f2update\fP) 篏障c \f2html\fP 障c膣箴с\f2html\fP c荀c腱糸 (cd) 障\f2\-linkoffline\fP 綣違潟c "." 絎2 綣違 \f2html\fP 吾後障鴻絎障 с\f2package\-list\fP 罎膣≪障 贋医丞с宴若吾宴若後絎 |
3791 .B \-link |
4880 .nf |
3792 を使用できます。 |
4881 \f3 |
3793 .B \-link |
4882 .fl |
3794 の相対リンクの使用例を参照してください。 |
4883 % \fP\f3javadoc \-d update \-linkoffline . html com.mypackage\fP |
3795 .LP |
4884 .fl |
3796 package-list ファイルの手動作成 - |
4885 .fi |
3797 .BR package-list |
4886 Javadoc 若腟篋緇\f2update/com/package\fP 鴻若吾潟若 (网荀膣√ゃ)\f2html/com/package\fP <ゃ筝吾障 |
3798 ファイルがまだ存在しなくても、ドキュメントのリンク先のパッケージ名がわかっている場合は、このファイルのコピーを自分で作成し、 |
4887 .LP |
3799 .I packagelistLoc |
4888 .TP 3 |
3800 でそのパスを指定することができます。 |
4889 \-linksource\ |
3801 com.apipackage が最初に作成されたときに |
4890 純若鴻<ゃ (茵垬) HTML 若吾с潟篏罔羣 HTML ャ<潟純若鴻<ゃ吾潟菴遵障潟純若鴻<ゃ絎h鴻ゃ潟帥с若鴻潟潟鴻帥<純c若絲障篏障潟潟鴻帥鴻絲障篏障 |
3802 com.spipackage のパッケージリストが存在しなかった、 |
4891 .LP |
3803 以前の場合がその例です。 |
4892 \f3激с潟\fP\f4\-public\fP\f3\fP\f4\-package\fP\f3\fP\f4\-protected\fP\f3\fP\f4\-private\fP\f3 激с潟≫鴻c若<純篏腟粋昭障純若鴻<ゃ鴻絎茖荅括完障\fP\f2\-private\fP 激с潟絎鴻ゃ潟帥с若鴻筝潟篁≪祉鴻с障 |
3804 この方法は、パッケージ名はわかっているものの、 |
4893 .LP |
3805 まだ公開されていない、新しい外部ドキュメントにリンクする |
4894 潟絎h茘ュ筝篏障違\f2Button\fP 鴻純若鴻潟若潟Button茯筝篏障 |
3806 ドキュメントを生成する場合に便利です。 |
|
3807 また、Javadoc 1.0 または 1.1 では package-list ファイルが |
|
3808 生成されないため、この方法で、これらのバージョンで |
|
3809 生成されたパッケージの package-list ファイルを生成できます。 |
|
3810 2 つの会社が未公開の package-list ファイルを |
|
3811 共有することもできるため、クロスリンクを設定した |
|
3812 ドキュメントを同時にリリースすることも可能です。 |
|
3813 .LP |
|
3814 複数のドキュメントにリンク - |
|
3815 .B \-linkoffline |
|
3816 は、参照先の生成ドキュメントごとに 1 つずつ指定します。 |
|
3817 次の例では、わかりやすくするために |
|
3818 オプションごとに行を分けています。 |
|
3819 .LP |
|
3820 .RS |
|
3821 .ft 3 |
|
3822 .nf |
|
3823 .ta 18n |
|
3824 % javadoc \-linkoffline docURL1 packagelistURL1 \\ |
|
3825 \-linkoffline docURL2 packagelistURL2 \\ |
|
3826 .ft 1 |
|
3827 ... |
|
3828 .fi |
|
3829 .RE |
|
3830 .LP |
|
3831 .B ドキュメントの更新: |
|
3832 .B \-linkoffline |
|
3833 オプションのもう 1 つの用途は、プロジェクトで多数のパッケージを使い、 |
|
3834 すでにツリー全体に対して |
|
3835 .B javadoc |
|
3836 を実行してある場合に、次の実行では、すばやく細かい |
|
3837 変更を行なってから、ソース |
|
3838 ツリーの一部に対してだけ |
|
3839 .B javadoc |
|
3840 を実行し直したい場合に便利です。これは、 |
|
3841 変更がドキュメンテーションコメントに対し |
|
3842 てであり、シグニチャに対してではない場合にだけ正常に |
|
3843 処理されるので、ハッキング |
|
3844 のようなものです。ソースコードに対してシグニチャを追加、 |
|
3845 削除または変更した場合は、索引、パッケージツリー、 |
|
3846 継承されるメンバのリスト、[使用] ページなどの場所 |
|
3847 で壊れたリンクが表示されます。 |
|
3848 .LP |
|
3849 まず、新しい実行のため、新規の |
|
3850 生成先ディレクトリ (update) を作成します。オリジナルの生成先ディレクトリを html とします。もっとも簡単な例として、html の親に移動します。 |
|
3851 .B \-linkoffline |
|
3852 の 1 番目の引数に現在のディレクトリ「.」を |
|
3853 設定し、2 番目の引数に package-list |
|
3854 を検索する場所である html への相対パスを設定します。更新したいパッケージのパッケージ名のみを渡します。 |
|
3855 .LP |
|
3856 .RS |
|
3857 .ft 3 |
|
3858 .nf |
|
3859 % javadoc \-d update \-linkoffline . html com.mypackage |
|
3860 .fi |
|
3861 .ft 1 |
|
3862 .RE |
|
3863 .LP |
|
3864 .B javadoc |
|
3865 の実行が終了したとき、 |
|
3866 .B update/com/package |
|
3867 内に生成されたクラス (概要や索引ではない) で、 |
|
3868 html/com/package 内にあるオリジナルのファイルを上書きコピーします。 |
|
3869 .TP |
|
3870 \-linksource |
|
3871 各ソースファイル (行番号付き) の HTML バージョンを作成し、標準 HTML ドキュメントからソースファイルへのリンクを追加します。リンクは、ソースファイル内に宣言されているクラス、インタフェース、コンストラクタ、メソッド、フィールドに対して作成されます。デフォルトコンストラクタ、生成されたクラスに対しては作成されません。 |
|
3872 .LP |
|
3873 \f3このオプションは、\fP\f4\-public\fP\f3、\fP\f4\-package\fP\f3、\fP\f4\-protected\fP\f3、\fP\f4\-private\fP\f3 の各オプションとは関係なく、非公開のクラス、フィールド、非公開のメソッドの本体をはじめとする組み込まれたソースファイル内の\fP\f4すべての\fP\f3非公開実装の詳細を公開します。\fP\f2\-private\fP オプションを指定しないかぎり、非公開のクラスやインタフェースの一部には、リンクを介してアクセスできないことがあります。 |
|
3874 .LP |
|
3875 各リンクは、その宣言内の識別子名の上に作成されます。たとえば、\f2Button\fP クラスのソースコードヘのリンクは、「Button」という語の上に作成されます。 |
|
3876 .nf |
4895 .nf |
3877 \f3 |
4896 \f3 |
3878 .fl |
4897 .fl |
3879 public class Button |
4898 public class Button |
3880 .fl |
4899 .fl |
4157 \fP |
5076 \fP |
4158 .fi |
5077 .fi |
4159 .LP |
5078 .LP |
4160 .TP 3 |
5079 .TP 3 |
4161 \-tag\ \ tagname:Xaoptcmf:"taghead" |
5080 \-tag\ \ tagname:Xaoptcmf:"taghead" |
4162 Javadoc ツールがドキュメンテーションコメント内の引数を 1 つ取る単純なカスタムブロックタグ \f2@\fP\f2tagname\fP を解釈できるようにします。これにより、Javadoc ツールはタグ名の「スペルチェック」を行うことができるので、ソースコード内のすべてのカスタムタグに \f2\-tag\fP オプションを組み込むことをお勧めします。今回の実行で出力されないタグは、\f2X\fP を付けて無効にします。 |
5081 Javadoc 若ャ<潟若激с潟潟<潟綣違 1 ゅ膣鴻帥帥 \f2@\fP\f2tagname\fP 茹iс障Javadoc 若帥医鴻с茵сс純若鴻潟若鴻鴻帥帥違 \f2\-tag\fP 激с潟腟粋昭с障篁絎茵у阪帥違\f2X\fP 篁≦鴻障 |
4163 .LP |
5082 .LP |
4164 コロン (\f4:\fP) は常に区切り文字になります。\f2tagname\fP でコロンを使用するには、「タグ名でのコロンの使用」を参照してください。 |
5083 潟 (\f4:\fP) 絽吾阪絖障\f2tagname\fP с潟潟篏睡帥医с潟潟篏睡с |
4165 .LP |
5084 .LP |
4166 \f2\-tag\fP オプションは、タグの見出し「\f2taghead\fP」を太字で出力します。その次の行には、このオプションの引数で指定したテキストが続きます。以下の例を参照してください。ブロックタグと同様、この引数のテキストにはインラインタグを含めることができます。このインラインタグも解釈されます。出力は、引数を 1 つ取る標準のタグ (\f2@return\fP、\f2@author\fP など) の出力とよく似ています。\f2taghead\fP を省略すると、\f2tagname\fP が見出しとして表示されます。 |
5085 \f2\-tag\fP 激с潟帥違荀冴taghead紊絖у阪障 罨<茵激с潟綣違ф絎鴻膓障 篁ヤ箴с帥違罕綣違鴻ゃ潟ゃ潟帥違с障 ゃ潟ゃ潟帥違茹i障阪綣違 1 ゅ罔羣帥 (\f2@return\fP\f2@author\fP ) 阪鋍若障\f2taghead\fP ャ\f2tagname\fP 荀冴茵腓冴障 |
4167 .LP |
5086 .LP |
4168 \f3タグの配置\fP \- 引数の \f4Xaoptcmf\fP 部分は、ソースコード内のタグを配置できる位置と、\f2X\fP を使ってこのタグを無効にできるかどうかを特定します。タグの配置位置を制限しない場合は \f4a\fP を指定します。それ以外の文字の組み合わせも可能です。 |
5087 \f3帥違臀\fP \- 綣違 \f4Xaoptcmf\fP 純若鴻潟若帥違臀с篏臀\f2X\fP 篏帥c帥違≦鴻с劫障帥違臀篏臀狗翫 \f4a\fP 絎障 篁ュ絖腟水純с \f4X\fP (帥違≦劫) |
4169 .br |
5088 .br |
4170 \f4X\fP (タグの無効化) |
5089 \f4a\fP (鴻篏臀) |
4171 .br |
5090 .br |
4172 \f4a\fP (すべての位置) |
5091 \f4o\fP (网荀) |
4173 .br |
5092 .br |
4174 \f4o\fP (概要) |
5093 \f4p\fP (宴若) |
4175 .br |
5094 .br |
4176 \f4p\fP (パッケージ) |
5095 \f4t\fP (<鴻潟ゃ潟帥с若) |
4177 .br |
5096 .br |
4178 \f4t\fP (型すなわちクラスおよびインタフェース) |
5097 \f4c\fP (潟潟鴻) |
4179 .br |
5098 .br |
4180 \f4c\fP (コンストラクタ) |
5099 \f4m\fP (<純) |
4181 .br |
5100 .br |
4182 \f4m\fP (メソッド) |
5101 \f4f\fP (c若) |
4183 .br |
5102 .LP |
4184 \f4f\fP (フィールド) |
5103 \f3激潟違帥違箴\fP \- 純若鴻潟若篁紙篏臀т戎ф帥違帥違激с潟箴腓冴障 |
4185 .LP |
5104 .nf |
4186 シングルタグの例 - |
5105 \f3 |
4187 ソースコードの任意の場所で使用できる |
5106 .fl |
4188 タグのタグオプションの例を示します。 |
5107 \-tag todo:a:"To Do:" |
4189 .LP |
5108 .fl |
4190 .RS |
5109 \fP |
4191 .TP 3 |
5110 .fi |
4192 \-tag todo:a:"To Do:" |
5111 @todo 潟潟鴻帥<純c若帥т戎翫篁ヤ激с潟篏睡障 |
4193 .RE |
5112 .nf |
4194 .LP |
5113 \f3 |
4195 コンストラクタ、メソッド、およびフィールドだけで @todo を |
5114 .fl |
4196 使用させるには、次のようにします。 |
5115 \-tag todo:cmf:"To Do:" |
4197 .LP |
5116 .fl |
4198 .RS |
5117 \fP |
4199 .ft 3 |
5118 .fi |
4200 .nf |
5119 筝箴緇潟 (\f2:\fP) <若水阪絖с荀冴鴻筝c障 (篁ヤ箴)罨<箴\f2@todo\fP 帥違純若鴻潟若с帥違激с潟篏睡障 |
4201 \-tag todo:cmf:"To Do:" |
5120 .nf |
4202 .fi |
5121 \f3 |
4203 .ft 1 |
5122 .fl |
4204 .RE |
5123 @todo The documentation for this method needs work. |
4205 .LP |
5124 .fl |
4206 上記では、末尾のコロン (:) がパラメータの |
5125 \fP |
4207 区切り記号ではなく、表示のとおり、 |
5126 .fi |
4208 見出しテキストの一部であることに注意してください。 |
5127 \f3帥医潟潟篏睡\fP \- 潟 (:) 鴻激ャс鴻宴若潟潟帥医篏睡с障ャ<潟若激с潟潟<潟筝с罨<篏睡障 |
4209 次のように、@todo タグを含むソースコードに |
5128 .nf |
4210 どちらかのタグオプションを使用します。 |
5129 \f3 |
4211 .LP |
5130 .fl |
4212 .RS |
5131 /** |
4213 .ft 3 |
5132 .fl |
4214 .nf |
5133 * @ejb:bean |
4215 @todo The documentation for this method needs work. |
5134 .fl |
4216 .fi |
5135 */ |
4217 .ft 1 |
5136 .fl |
4218 .LP |
5137 \fP |
4219 タグ名にコロンを使用する \- |
5138 .fi |
4220 コロン (:) をバックスラッシュでエスケープすると、 |
5139 с帥違激с潟篏睡 |
4221 コロンをタグ名に使用することができます。 |
5140 .nf |
4222 .LP |
5141 \f3 |
4223 .RS 5 |
5142 .fl |
4224 .nf |
5143 \-tag ejb\\\\:bean:a:"EJB Bean:" |
4225 /** |
5144 .fl |
4226 * @ejb:bean |
5145 \fP |
4227 */ |
5146 .fi |
4228 .RE |
5147 \f3帥医鴻с (帥違≦劫)\fP \- 純若鴻潟若臀筝鴻帥帥違阪吟翫障翫純若鴻潟若鴻帥違臀阪吟帥違鴻阪吟帥違≦鴻障帥違≦鴻\f2X\fP 絎障絎帥違鴻障 Javadoc 若罎冴帥違ュ鴻ャ帥違с劫с障ャ帥違罎冴翫Javadoc 若茘阪障 |
4229 .fi |
5148 .LP |
4230 .LP |
5149 с臀ゃ \f2X\fP 菴遵с障 違\f2X\fP ゃс帥違鴻с障違@todo 帥違阪吟翫罨<絎障 |
4231 でこのタグオプションを使用すると、 |
5150 .nf |
4232 .LP |
5151 \f3 |
4233 .RS 5 |
5152 .fl |
4234 .nf |
5153 \-tag todo:Xcmf:"To Do:" |
4235 \-tag ejb\\:bean:a:"EJB Bean:" |
5154 .fl |
4236 .RE |
5155 \fP |
4237 .LP |
5156 .fi |
4238 となります。 |
5157 膣絎号障 |
4239 .fi |
5158 .nf |
4240 .ft 1 |
5159 \f3 |
4241 .RE |
5160 .fl |
4242 .LP |
5161 \-tag todo:X |
4243 タグ名のスペルチェック (タグの無効化) - 開発者は、ソースコードの中で出力できないカスタムタグを使用することがあります。その場合、ソースタグに存在するすべてのタグをリストし、出力するタグを有効化し、出力しないタグを無効化することが重要です。 X を使用するとタグを無効化でき、これがない場合はタグが有効となります。 この文字の存在によって、 |
5162 .fl |
4244 .B Javadoc |
5163 \fP |
4245 ツールは、検出したタグが未知のタグで、おそらく綴り間違いであると判断できます。 この場合、警告メッセージが表示されます。 |
5164 .fi |
4246 .LP |
5165 .LP |
4247 すでに存在する、配置を指定する引数の値に X を追加した場合、タグを有効にしたいときに X を削除できます。 たとえば、@todo が出力したくないタグの場合、次のようにします。 |
5166 罕 \f2\-tag todo:X\fP \f2@todo\fP taglet у臂翫鴻с |
4248 .LP |
5167 .LP |
4249 .RS |
5168 \f3帥違綺\fP \- \f2\-tag\fP ( \f2\-taglet\fP) 激с潟綺c阪綺羆阪障鴻帥帥違罔羣帥違腟水篏睡с障罔羣帥違帥違激с潟綺羆阪若鴻с罔羣帥医帥篏睡障(罔羣帥違絨頳冴紊眼с障)ゃ篁ヤ箴ц障 |
4250 .ft 3 |
5169 .LP |
4251 .nf |
5170 \f2\-tag\fP 翫\f2\-taglet\fP 篏臀c綺羆阪障帥違筝≧鴻絖翫潟潟茵緇祉綺羆阪障帥違帥違潟潟茵絎с違\f2\-taglet\fP \f2\-tag\fP 筝≧鴻 todo c翫潟潟茵緇祉綺羆阪障 |
4252 \-tag todo:Xcmf:"To Do:" |
5171 .LP |
4253 .fi |
5172 \f3帥違絎祉箴\fP \- 箴с阪ParametersThrowsTo Do水ャ障X 篏睡@example 純若鴻潟若篁絎茵с阪帥違с絎障@argfile 篏睡翫罨<綣違<ゃャ茵帥違臀с障 茵膓膓腓冴絖筝荀с |
4254 .ft 1 |
5173 .nf |
4255 .RE |
5174 \f3 |
4256 .LP |
5175 .fl |
4257 または、次のようにより簡単にすることもできます。 |
5176 \-tag param |
4258 .LP |
5177 .fl |
4259 .RS |
5178 \-tag return |
4260 .ft 3 |
5179 .fl |
4261 .nf |
5180 \-tag todo:a:"To Do:" |
4262 \-tag todo:X |
5181 .fl |
4263 .fi |
5182 \-tag throws |
4264 .ft 1 |
5183 .fl |
4265 .RE |
5184 \-tag see |
4266 .LP |
5185 .fl |
4267 \-tag todo:X の構文は、@todo がタグレットで |
5186 \-tag example:X |
4268 定義されている場合も有効です。 |
5187 .fl |
4269 .LP |
5188 \fP |
4270 タグの順序 - |
5189 .fi |
4271 \-tag (および \-taglet) オプションの順序に従って |
5190 .LP |
4272 タグが出力されます。 カスタムタグと標準タグを |
5191 javadoc ャ<潟若激с潟潟<潟茹f罎冴帥違<罔羣帥違с \f2\-tag\fP \f2\-taglet\fP ф検帥違сャ帥違荀障 翫茘鴻若障 |
4273 混在させることができます。 標準タグのタグオプションは、 |
5192 .LP |
4274 順序を決定するためだけのプレースホルダです。 |
5193 罔羣帥違綺с鴻主障\f2\-tag\fP 激с潟篏睡鴻菴遵帥違≧羣帥違篏臀篏臀腱糸障ゃ障罔羣帥違 \f2\-tag\fP 激с潟篁違篏臀臀障障障 |
4275 これらは標準タグ名だけを使用します |
5194 .LP |
4276 (標準タグの小見出しは変更できません)。 |
5195 \f3腴九\fP \- 堺腥咲蚊宴若吾篏睡 \f2com.mycompany.todo\fP (.) 阪遵荀篏睡障Sun 篁緇障罔羣帥違篏障若吟若篏帥違Sun 箴帥違篏若若ゃ障ゃ障若吟若 \f2@todo\fP 帥違障帥違篏翫Sun 罔羣帥違篏帥違障帥違篏篆障 |
4277 これを次の例に示します。 |
5196 .LP |
4278 .LP |
5197 \f3羈 vs. Javadoc 帥\fP \- 筝菴遵綽荀若≪ャ<潟若激с潟綵演帥筝ャ<潟若激с潟с翫若≪ javadoc 帥違鴻с 篁ュ翫羈鴻с |
4279 \-tag がない場合、\-taglet の場所によってその順序が決まります。 |
|
4280 この 2 つが両方ある場合は、コマンド行の最後に使用された方が |
|
4281 順序を決定します (これは、タグとタグレットが、 |
|
4282 コマンド行で使用された順に処理されるためです)。 |
|
4283 たとえば、\-taglet と \-tag が両方とも todo という |
|
4284 名前である場合、コマンド行の最後で使用された |
|
4285 方が順序を決定します。 |
|
4286 .LP |
|
4287 タグの完全なセットの例 - |
|
4288 この例では、出力の Parameters と Throws の間に |
|
4289 To Do を挿入します。 「X」を使用して、@example が |
|
4290 ソースコード内の今回の実行で出力されないタグで |
|
4291 あることを指定できます。 @argfile を使用すると、 |
|
4292 次のように行の継続文字なしで、 |
|
4293 引数ファイルの異なる行にタグを配置できます。 |
|
4294 .LP |
|
4295 .RS |
|
4296 .ft 3 |
|
4297 .nf |
|
4298 \-tag param |
|
4299 \-tag return |
|
4300 \-tag todo:a:"To Do:" |
|
4301 \-tag throws |
|
4302 \-tag see |
|
4303 \-tag example:X |
|
4304 .fi |
|
4305 .ft 1 |
|
4306 .RE |
|
4307 .LP |
|
4308 javadoc がドキュメンテーションコメントを解析する際に、 |
|
4309 検出されたタグのうち、標準タグでもなく、 |
|
4310 \-tag や \-taglet で渡されるタグでもないものは、 |
|
4311 不明なタグとして認識し、警告がスローされます。 |
|
4312 .LP |
|
4313 標準タグは、最初、デフォルトの順序で |
|
4314 リスト内部的に格納されます。 |
|
4315 \-tag オプションを使用すると、このタグがリストに追加されます。 |
|
4316 標準タグはデフォルトの位置から移動します。 |
|
4317 そのため、標準タグで \-tag オプションが省略されると、 |
|
4318 デフォルトの位置に配置されたままになります。 |
|
4319 .LP |
|
4320 競合の回避 - |
|
4321 固有のネームスペースを細かく分けるには、 |
|
4322 パッケージに使用されている com.mycompany.todo |
|
4323 という名前のように、ドット (.) を区切り記号とする名前を使います。 |
|
4324 Sun は今後もドットを含まない標準タグを作成します。 |
|
4325 ユーザが作成したタグは、Sun が定義した同じ |
|
4326 名前のタグの動作をオーバーライドします。 |
|
4327 つまり、ユーザが @todo という名前のタグまたは |
|
4328 タグレットを作成していた場合、そのあとで Sun が |
|
4329 同じ名前の標準タグを作成しても、ユーザが定義した |
|
4330 動作はそのまま維持されます。 |
|
4331 .LP |
|
4332 \f3注釈 vs. Javadoc タグ\fP \- 一般に、追加する必要のあるマークアップが、ドキュメンテーションに影響を与えたりドキュメンテーションを生成したりするためのものである場合、そのマークアップは javadoc タグにすべきです。それ以外の場合は注釈にすべきです。 |
|
4333 .na |
5198 .na |
4334 「\f2Comparing Annotations and Javadoc Tags\fP」 |
5199 \f2Comparing Annotations and Javadoc Tags\fP @ |
4335 .fi |
5200 .fi |
4336 (http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#annotations) を参照してください。 |
5201 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#annotationsс |
4337 .LP |
5202 .LP |
4338 \-taglet オプションを使用して、より複雑な |
5203 \-taglet 激с潟篏睡茲帥違鴻帥ゃ潟ゃ潟帥違 篏с障 |
4339 スタンドアロンタグやカスタムインラインタグを |
5204 .LP |
4340 作成することができます。 |
5205 .TP 3 |
4341 .TP |
5206 \-taglet\ \ class |
4342 \-taglet class |
5207 帥違ャ<潟篏帥莎桁鴻<ゃ絎障鴻絎絎絎帥違鴻帥帥違鴻綣違違絎臂障帥違綣違篁阪障紊ャ<潟泣潟帥違ゃ篁ヤс |
4343 タグのドキュメントの生成に使うタグレットを起動するための |
5208 .RS 3 |
4344 クラスファイルを指定します。 |
5209 .TP 2 |
4345 クラスの完全修飾名を指定してください。 |
5210 o |
4346 このタグレットは、カスタムタグが持っているテキスト引数の |
5211 .na |
4347 数も定義します。 タグレットはこれらの引数を受け取り、 |
5212 \f2帥違网荀\fP @ |
4348 処理し、出力を生成します。 タグレットの例の詳細については、 |
5213 .fi |
4349 タグレットの概要を参照してください。 |
5214 http://java.sun.com/javase/6/docs/technotes/guides/javadoc/taglet/overview.html |
4350 .LP |
5215 .RE |
4351 タグレットはスタンドアロンタグまたはインラインタグに |
5216 .LP |
4352 使用すると便利です。 タグレットでは任意の |
5217 帥違罔羣帥違障ゃ潟ゃ潟帥違т梢с帥違篁紙違綣違с障 障鴻紊絖膊≧吾篏鴻<ゃ吾冴篁祉鴻紮鴻帥篏絎茖с障 |
4353 数の引数を持つことができ、カスタムの動作を実装できます。 |
5218 .LP |
4354 たとえば、テキストを太字にしたり、箇条書き形式にしたり、 |
5219 帥違ф絎с帥違臀贋臀綵√帥с篁鴻羆阪c茵障帥違篏睡鴻鴻劫ゃ絎茵с障帥違鴻<ゃ阪ャ祉鴻若篏緇障 |
4355 テキストをファイルに書き出したり、 |
5220 .LP |
4356 他のプロセスを起動したりすることができるのです。 |
5221 帥違鴻絎\f2\-tagletpath\fP 激с潟篏睡障篁ヤ若吾ParameterThrowsTo Do帥違水ャ箴с |
4357 .LP |
5222 .nf |
4358 タグレットで指定できるのは、タグの配置場所と配置形式のみです。その他のすべての決定は、ドックレットによって行われます。タグレットを使用しても、包含クラスのリストからクラス名を削除するなどの処理は実行できません。ただし、タグのテキストをファイルに出力したり、別のプロセスをトリガするなどの副作用は得られます。 |
5223 \f3 |
4359 .LP |
5224 .fl |
4360 タグレットへのパスを指定するには、 |
5225 \-taglet com.sun.tools.doclets.ToDoTaglet |
4361 .B \-tagletpath |
5226 .fl |
4362 オプションを使用します。 |
5227 \-tagletpath /home/taglets |
4363 生成されたページの Parameters と Throws の間に |
5228 .fl |
4364 To Do タグレットを挿入する例を示します。 |
5229 \-tag return |
4365 .LP |
5230 .fl |
4366 .RS |
5231 \-tag param |
4367 .ft 3 |
5232 .fl |
4368 .nf |
5233 \-tag todo |
4369 \-taglet com.sun.tools.doclets.ToDoTaglet |
5234 .fl |
4370 \-tagletpath /home/taglets |
5235 \-tag throws |
4371 \-tag return |
5236 .fl |
4372 \-tag param |
5237 \-tag see |
4373 \-tag todo |
5238 .fl |
4374 \-tag throws |
5239 \fP |
4375 \-tag see |
5240 .fi |
4376 .fi |
5241 .LP |
4377 .ft 1 |
5242 \f2\-tag\fP 激с潟篁c \f2\-taglet\fP 激с潟篏睡с障茯帥\f2\-tag\fP 激с潟篏睡祉с |
4378 .RE |
5243 .LP |
4379 .LP |
5244 .TP 3 |
4380 .B \-taglet |
5245 \-tagletpath\ \ tagletpathlist |
4381 オプションを |
5246 taglet 鴻<ゃ (.class) 罎膣≪鴻絎障\f2tagletpathlist\fP 潟 (\f2:\fP) у阪c茲違鴻с障Javadoc 若絎鴻篁ヤ鴻泣c罎膣≪障 |
4382 .B \-tag |
5247 .LP |
4383 オプションの代わりに使用することもできますが、 |
5248 .TP 3 |
4384 その結果、読みにくくなります。 |
5249 \-docfilessubdirs\ |
4385 .TP |
5250 \f2doc\-files\fP c羞宴潟若鴻障ゃ障潟弱泣c鴻潟潟潟潟若障違\f2doc\-files/example/images\fP c筝<ゃ潟若障с泣cゅ絎純с |
4386 \-tagletpath tagletpathlist |
5251 .LP |
4387 taglet クラスファイル (.class) を探すための検索パスを指定します。 |
5252 .TP 3 |
4388 .I tagletpathlist |
5253 \-excludedocfilessubdir\ \ name1:name2... |
4389 には、コロン (:) で |
5254 絎 \f2doc\-files\fP 泣cゅ障SCCS 篁純若鴻潟若九勝泣c潟若蚊障 |
4390 区切って複数のパスを含めることができます。 |
5255 .LP |
4391 .B Javadoc |
5256 .TP 3 |
4392 ツールは、指定されたパス以下のすべての |
5257 \-noqualifier\ \ all\ | \ packagename1:packagename2:... |
4393 サブディレクトリを検索します。 |
5258 阪劫宴若後 (宴若娯信蕋上) ャ障\f2\-noqualifier\fP 綣違 \f2all\fP 絎翫鴻宴若娯信蕋上鴻ャ障 ゃ茲違宴若後潟潟у阪cゃ若絎с障鴻障ゃ潟帥с若劫茵腓冴篏臀宴若後ゃ障 |
4394 .TP |
5259 .LP |
4395 \-docfilessubdirs |
5260 罨<箴с鴻宴若娯信蕋上ャ障 |
4396 doc-files ディレクトリを、下の階層を含めてコピー |
5261 .nf |
4397 できるようにします。 つまり、サブディレクトリとすべての |
5262 \f3 |
4398 コンテンツが、生成先ディレクトリに再帰的にコピーされます。 |
5263 .fl |
4399 たとえば、 |
5264 \-noqualifier all |
4400 .BR doc-files/example/images |
5265 .fl |
4401 ディレクトリとその中のファイルがコピーされます。 |
5266 \fP |
4402 サブディレクトリを除外するためのオプションもあります。 |
5267 .fi |
4403 .TP |
5268 罨<箴с宴若娯信蕋上 java.lang java.io ャ障 |
4404 \-excludedocfilessubdirs name1:name2:... |
5269 .nf |
4405 doc-files のサブディレクトリで、指定された |
5270 \f3 |
4406 名前のものを除外します。 このオプションを使用すると、 |
5271 .fl |
4407 SCCS およびその他のソースコード管理の |
5272 \-noqualifier java.lang:java.io |
4408 サブディレクトリをコピーしないようにできます。 |
5273 .fl |
4409 .TP |
5274 \fP |
4410 \-noqualifier all | packagename1:packagename2:... |
5275 .fi |
4411 修飾パッケージ名を、出力のクラス名の前から削除します。 |
5276 罨<箴сjava у障宴若娯信蕋上 com.sun 泣宴若 (javax с) ャ障 |
4412 \-noqualifier の引数は |
5277 .nf |
4413 all (すべてのパッケージ修飾子を削除)、 |
5278 \f3 |
4414 またはコロンで区切られたパッケージリストの |
5279 .fl |
4415 いずれかで、修飾子として削除されます。 |
5280 \-noqualifier java.*:com.sun.* |
4416 ワイルドカードも使用できます。 |
5281 .fl |
4417 パッケージ名はクラス名またはインタフェース名が |
5282 \fP |
4418 表示されたところから削除されます。 |
5283 .fi |
4419 .LP |
5284 宴若娯信蕋上筝荐篏緇c茵腓冴翫障 荅括完茵腓堺号с荀\f2\-noqualifier\fP 篏睡鴻с |
4420 次の例では、すべてのパッケージ修飾子を省略します。 |
5285 .LP |
4421 .LP |
5286 .TP 3 |
4422 .RS |
5287 \-notimestamp\ |
4423 .ft 3 |
5288 帥ゃ鴻帥潟吟障 若後菴 HTML HTML 潟<潟с帥ゃ鴻帥潟障Javadoc 2 ゃ純若鴻若鴻у茵絲障 diff 絎茵激с潟篏睡帥ゃ鴻帥潟c diff 榊т梢с (激с潟篏睡若吾 diff 障)帥ゃ鴻帥潟 Javadoc 若吾с括垩障罨<障 |
4424 .nf |
5289 .nf |
4425 \-noqualifier all |
5290 \f3 |
4426 .fi |
5291 .fl |
4427 .ft 1 |
5292 <!\-\- Generated by javadoc (build 1.5.0\-internal) on Tue Jun 22 09:57:24 PDT 2004 \-\-> |
4428 .RE |
5293 .fl |
4429 .LP |
5294 \fP |
4430 次の例では、パッケージ修飾子 java.lang |
5295 .fi |
4431 および java.io を省略します。 |
5296 .LP |
4432 .LP |
5297 .TP 3 |
4433 .RS |
5298 \-nocomment\ |
4434 .ft 3 |
5299 筝肢潟鴻帥違潟<潟篏吟絎h障激с潟違c純若鴻<ゃ違吾с罧級с鴻宴 HTML ャ<潟篏с障 |
4435 .nf |
5300 .RE |
4436 \-noqualifier java.lang:java.io |
5301 .SH "潟潟茵綣違<ゃ" |
4437 .fi |
5302 .LP |
4438 .ft 1 |
5303 .LP |
4439 .RE |
5304 \f2javadoc\fP 潟潟茵膂≧\f2javadoc\fP 潟潟絲障綣 (\f2\-J\fP 激с潟ゃ) ャc 1 や札筝<ゃ絎с障違若c潟違激鴻筝с篁紙激 javadoc 潟潟篏с障 |
4440 .LP |
5305 .LP |
4441 次の例では、java および com.sun から |
5306 .LP |
4442 始まる (javax を除く) |
5307 綣違<ゃjavac 激с潟純若鴻<ゃ宴腟水荐菴違с障<ゃ綣違鴻若鴻障壕у阪障<ゃ腥榊純障翫<ゃ篏篋綣膃у蚊帥障 |
4443 サブパッケージのパッケージ修飾子を削除します。 |
5308 .LP |
4444 .LP |
5309 .LP |
4445 .RS |
5310 綣違<ゃ<ゃ憜c荀後障鴻障綣違<ゃ篏臀荀後障鴻с障綣違<ゃ<ゃ鴻сゃ若 (*) 篏睡с障違\f2*.java\fP 絎с障綣違<ゃ綣違 \f2@\fP 絖篏睡茲違<ゃ絽亥茹i泣若障障\f2\-J\fP 激с潟泣若障 激с潟莎桁若羝<障莎桁若с綣違<ゃ泣若с |
4446 .ft 3 |
5311 .LP |
4447 .nf |
5312 .LP |
4448 \-noqualifier java.*:com.sun.* |
5313 javadoc 絎茵綣違<ゃ鴻<ゃ \f2@\fP 絖篁羝<障javadoc \f2@\fP 絖у障綣違荀ゃ<ゃ絎鴻絮綣違鴻水ャ障 |
4449 .fi |
5314 .LP |
4450 .ft 1 |
5315 .SS |
4451 .RE |
5316 綣違<ゃ 1 ゆ絎箴 |
4452 .LP |
5317 .LP |
4453 パッケージ修飾子が上記の動作に従って表示される場合、名前は適切に短くされます。詳細は「名前の表示方法」を参照してください。この規則は、 |
5318 .LP |
4454 \-noqualifier が |
5319 \f2argfile\fP 綣違<ゃ鴻 Javadoc 綣違主罨<篏睡с障 |
4455 使用されているかどうかにかかわらず存在します。 |
5320 .LP |
4456 .TP |
5321 .nf |
4457 .BI \-notimestamp |
5322 \f3 |
4458 タイムスタンプが抑制されます。 |
5323 .fl |
4459 各ページ先頭近くにある、生成された HTML 内の |
5324 % \fP\f3javadoc @argfile\fP |
4460 HTML コメントでタイムスタンプが隠されます。 |
5325 .fl |
4461 .B Javadoc |
5326 .fi |
4462 を 2 つのソースベースで実行し、それらに対して |
5327 |
4463 diff を実行するときにこのオプションを使用すると、 |
5328 .LP |
4464 タイムスタンプによって diff が発生しなくなるので |
5329 .LP |
4465 便利です (このオプションを使用しないと、 |
5330 綣違<ゃ罨<箴хず 2 ゃ<ゃ絎鴻筝≧鴻ャс障 |
4466 各ページで diff になります)。 |
5331 .LP |
4467 タイムスタンプには |
5332 .SS |
4468 .B Javadoc |
5333 綣違<ゃ 2 ゆ絎箴 |
4469 のバージョン番号が含まれており、 |
5334 .LP |
4470 次のようになります。 |
5335 .LP |
4471 .LP |
5336 Javadoc 激с括 1 ゃ純若鴻<ゃ 1 ゃ2 ゃ綣違<ゃ篏罨<篏睡с障鴻с茵膓膓絖篏睡障 |
4472 .RS 5 |
5337 .LP |
4473 <!-- Generated by javadoc (build 1.5.0-internal) |
5338 .LP |
4474 on Tue Jun 22 09:57:24 PDT 2004 --> |
5339 篁ヤ絎鴻 \f2options\fP <ゃ篏障 |
4475 .RE |
5340 .LP |
4476 .TP |
5341 .nf |
4477 \-nocomment |
5342 \f3 |
4478 記述およびすべてのタグを含むコメント |
5343 .fl |
4479 本文全体を抑制し、宣言だけを生成します。 |
5344 \-d docs\-filelist |
4480 このオプションにより、元は異なる目的のためだった |
5345 .fl |
4481 ソースファイルを再利用し、 |
5346 \-use |
4482 新しいプロジェクトのためのスケルトンを |
5347 .fl |
4483 作成できるようになりました。 |
5348 \-splitindex |
4484 .SS コマンド行引数ファイル |
5349 .fl |
4485 .BR javadoc |
5350 \-windowtitle 'Java 2 Platform v1.3 API Specification' |
4486 のコマンド行を短くしたり簡潔にしたりするために、 |
5351 .fl |
4487 .BR javadoc |
5352 \-doctitle 'Java(TM) 2 Platform 5.0 API Specification' |
4488 コマンドに対する引数 (\-J オプションを除く) が |
5353 .fl |
4489 入った 1 つ以上のファイルを指定することができます。 |
5354 \-header '<b>Java 2 Platform </b><br><font size="\-1">5.0</font>' |
4490 このことを利用すれば、どのオペレーティングシステム |
5355 .fl |
4491 上でも、任意の長さの |
5356 \-bottom 'Copyright 1993\-2000 Sun Microsystems, Inc. All Rights Reserved.' |
4492 .BR javadoc |
5357 .fl |
4493 コマンドを作成できます。 |
5358 \-group "Core Packages" "java.*" |
4494 .LP |
5359 .fl |
4495 引数ファイルには、javac オプションとソースファイル名を |
5360 \-overview /java/pubs/ws/1.5/src/share/classes/overview\-core.html |
4496 自由に組み合わせて記述できます。 |
5361 .fl |
4497 また、Javadoc オプションに対する引数だけを記述してもかまいません。 |
5362 \-sourcepath /java/pubs/ws/1.5/src/share/classes |
4498 ファイル内の各引数は、空白文字または改行で区切ります。 |
5363 .fl |
4499 ファイル名に空白が含まれている場合は、そのファイル名全体を二重引用符で囲む必要があります。 |
5364 \fP |
4500 .LP |
5365 .fi |
4501 .LP |
5366 |
4502 引数ファイル内のファイル名は、 |
5367 .LP |
4503 現在のディレクトリから見た相対パスになります。 |
5368 .LP |
4504 引数ファイルの位置から見た相対パスではありません。 |
5369 篁ヤ絎鴻 \f2packages\fP <ゃ篏障 |
4505 引数ファイル内のファイル名リストでは、 |
5370 .LP |
4506 ワイルドカード (*) は使用できません。 |
5371 .nf |
4507 たとえば、*.java とは指定できません。 |
5372 \f3 |
4508 引数ファイル内の引数で @ 文字を使用して、 |
5373 .fl |
4509 複数のファイルを再帰的に解釈することはサポートされていません。 |
5374 com.mypackage1 |
4510 また、\-J オプションもサポートされていません。 |
5375 .fl |
4511 このオプションは起動ツールに渡されますが、 |
5376 com.mypackage2 |
4512 起動ツールでは引数ファイルをサポートしていないからです。 |
5377 .fl |
4513 .LP |
5378 com.mypackage3 |
4514 .BR javadoc |
5379 .fl |
4515 を実行するときに、各引数ファイルのパスとファイル名の |
5380 \fP |
4516 先頭に @ 文字を付けて渡します。 |
5381 .fi |
4517 .BR javadoc |
5382 |
4518 は、@ 文字で始まる引数を見つけると、 |
5383 .LP |
4519 そのファイルの内容を展開して引数リストに挿入します。 |
5384 .LP |
4520 .LP |
5385 罨<潟潟篏睡 javadoc 絎茵障 |
4521 引数ファイルを 1 つ指定する例 |
5386 .LP |
4522 .LP |
5387 .nf |
4523 argfile という名前の引数ファイルにすべての |
5388 \f3 |
4524 Javadoc 引数を格納し、次のように使用することができます。 |
5389 .fl |
4525 .LP |
5390 % \fP\f3javadoc @options @packages\fP |
4526 .RS |
5391 .fl |
4527 .ft 3 |
5392 .fi |
4528 .nf |
5393 |
4529 % javadoc @argfile |
5394 .LP |
4530 .fi |
5395 .SS |
4531 .ft 1 |
5396 剛綣違<ゃ箴 |
4532 .RE |
5397 .LP |
4533 .LP |
5398 .LP |
4534 この引数ファイルには、次の例で示されている |
5399 綣違<ゃ鴻絎с障 <ゃ絎<ゃ憜篏罐c荀後障鴻障 ゃ障筝箴翫\f2path1\fP \f2path2\fP 荀後障鴻с障 |
4535 2 つのファイルの内容を両方とも入れることができます。 |
5400 .LP |
4536 .LP |
5401 .nf |
4537 引数ファイルを 2 つ指定する例 |
5402 \f3 |
4538 .LP |
5403 .fl |
4539 Javadoc オプション用に 1 つ、パッケージ名またはソースファイル名用に |
5404 % \fP\f3javadoc @path1/options @path2/packages\fP |
4540 1 つというように、2 つの引数ファイルを作成し、 |
5405 .fl |
4541 次のようにして使用することができます。 |
5406 .fi |
4542 なお、このあとのリストでは、行の継続文字を使用していません。 |
5407 |
4543 .LP |
5408 .LP |
4544 以下の内容を含む options という名前のファイルを作成します。 |
5409 .SS |
4545 .LP |
5410 激с潟綣違箴 |
4546 .RS |
5411 .LP |
4547 .ft 3 |
5412 .LP |
4548 .nf |
5413 罨<Javadoc 激с潟絲障綣違綣違<ゃ主箴腓冴障с\f2\-bottom\fP 箴筝障 激с潟激綣違絎с障激с潟鴻綣違罨<絎鴻\f2bottom\fP <ゃ篏障 |
4549 \-d docs-filelist |
5414 .LP |
4550 \-use |
5415 .nf |
4551 \-splitindex |
5416 \f3 |
4552 \-windowtitle 'Java 2 Platform v1.3 API Specification' |
5417 .fl |
4553 \-doctitle 'Java<sup><font size="-2">TM</font></sup> 2\\ |
5418 '<font size="\-1"><a href="http://java.sun.com/cgi\-bin/bugreport.cgi">Submit a |
4554 Platform 5.0 API Specification' |
5419 .fl |
4555 \-header '<b>Java 2 Platform </b><br><font size="-1">5.0</font>' |
5420 bug or feature</a><br><br>Java is a trademark or registered trademark of |
4556 \-bottom 'Copyright 1993-2000 Sun Microsystems, Inc. All Rights Reserved.' |
5421 .fl |
4557 \-group "Core Packages" "java.*" |
5422 Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993\-2000 Sun |
4558 \-overview /java/pubs/ws/1.5/src/share/classes/overview-core.html |
5423 .fl |
4559 \-sourcepath /java/pubs/ws/1.5/src/share/classes |
5424 Microsystems, Inc. 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. |
4560 .fi |
5425 .fl |
4561 .ft 1 |
|
4562 .RE |
|
4563 .LP |
|
4564 以下の内容を含む packages という名前のファイルを作成します。 |
|
4565 .LP |
|
4566 .RS |
|
4567 .ft 3 |
|
4568 .nf |
|
4569 com.mypackage1 |
|
4570 com.mypackage2 |
|
4571 com.mypackage3 |
|
4572 .fi |
|
4573 .ft 1 |
|
4574 .RE |
|
4575 .LP |
|
4576 そのあと、次のコマンドを使用して javadoc を実行します。 |
|
4577 .LP |
|
4578 .RS |
|
4579 .ft 3 |
|
4580 .nf |
|
4581 % javadoc @options @packages |
|
4582 .fi |
|
4583 .ft 1 |
|
4584 .RE |
|
4585 .LP |
|
4586 パス付きの引数ファイルの例 |
|
4587 .LP |
|
4588 引数ファイルには、パスを指定できます。 |
|
4589 ただし、そのファイル内に指定されたファイル名は、 |
|
4590 現在の作業ディレクトリから見た相対パスになります。 |
|
4591 つまり、下の例の場合は、path1 や |
|
4592 path2 から見た相対パスではありません。 |
|
4593 .LP |
|
4594 .RS |
|
4595 .ft 3 |
|
4596 .nf |
|
4597 % javadoc @path1/options @path2/packages |
|
4598 .fi |
|
4599 .ft 1 |
|
4600 .RE |
|
4601 .LP |
|
4602 オプションの引数の例 |
|
4603 .LP |
|
4604 次に、javadoc オプションに対する引数だけを引数ファイルに |
|
4605 格納する例を示します。 ここでは、\-bottom オプションを |
|
4606 例に取り上げます。そのオプションには、 |
|
4607 かなり長い引数を指定することがあるからです。 |
|
4608 まず、このオプションのテキスト引数になる |
|
4609 次のような内容を含む、bottom という名前の |
|
4610 ファイルを作成します。 |
|
4611 .LP |
|
4612 '<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi"> |
|
4613 Submit a bug or feature</a><br><br>Java is a |
|
4614 trademark or registered trademark of |
|
4615 Sun Microsystems, Inc. in the US and other |
|
4616 countries.<br>Copyright 1993-2000 Sun |
|
4617 Microsystems, Inc. 901 San Antonio Road,<br>Palo |
|
4618 Alto, California, 94303, U.S.A. |
|
4619 All Rights Reserved.</font>' |
5426 All Rights Reserved.</font>' |
4620 .LP |
5427 .fl |
4621 そのあと、次のようにして |
5428 \fP |
4622 .B javadoc |
5429 .fi |
4623 ツールを実行します。 |
5430 |
4624 .LP |
5431 .LP |
4625 .TP 3 |
5432 .LP |
4626 % javadoc \-bottom @bottom @packages |
5433 罨< Javadoc 若絎茵障 |
4627 .LP |
5434 .LP |
4628 また、引数ファイルの先頭に |
5435 .nf |
4629 \-bottom オプションを組み込んでおけば、次のようにして実行できます。 |
5436 \f3 |
4630 .LP |
5437 .fl |
4631 .RS |
5438 % \fP\f3javadoc \-bottom @bottom @packages\fP |
4632 .ft 3 |
5439 .fl |
4633 .nf |
5440 .fi |
4634 % javadoc @bottom @packages |
5441 |
4635 .fi |
5442 .LP |
4636 .ft 1 |
5443 .LP |
4637 .RE |
5444 障綣違<ゃ \f2\-bottom\fP 激с潟腟粋昭с違罨<絎茵с障 |
4638 .TP |
5445 .LP |
4639 .SH 実行 |
5446 .nf |
4640 .SS Javadoc の実行 |
5447 \f3 |
4641 バージョン番号 - |
5448 .fl |
4642 .LP |
5449 % \fP\f3javadoc @bottom @packages\fP |
4643 javadoc のバージョン番号は |
5450 .fl |
4644 .BR javadoc \-J\-version |
5451 .fi |
4645 を使用することで確認できます。 |
5452 .SH "" |
4646 標準ドックレットのバージョン番号は出力ストリームに |
5453 絎茵 |
4647 表示されます。 |
5454 .SH "Javadoc 絎茵" |
4648 これは \-quiet オプションでオフにできます。 |
5455 .LP |
4649 .LP |
5456 .LP |
4650 プログラムから利用できる public インタフェース - |
5457 \f3若吾с括\fP \- javadoc 若吾с括垩ゅャ\f3javadoc \-J\-version\fP 篏睡障阪鴻若罔羣若吾с括垩障障\f2\-quiet\fP х≦鴻с障 |
4651 Java 言語で書かれたプログラム内から |
5458 .LP |
4652 .B javadoc |
5459 .LP |
4653 ツールを呼び出します。 |
5460 \f3違ゃ潟帥с若\fP \- Java 荐茯ц菴違違 Javadoc 若莎桁篏睡障ゃ潟帥с若鴻 \f2com.sun.tools.javadoc.Main\fP 障 (javadoc ュ)荅括完 |
4654 このインタフェースは |
|
4655 .BR com.sun.tools.javadoc.Main |
|
4656 (javadoc は再入) |
|
4657 にあります。 詳細は、「標準ドックレット」 |
|
4658 を参照してください。 |
|
4659 .LP |
|
4660 \f3ドックレットの実行\fP \- |
|
4661 下記の説明は、標準 HTML ドックレットを呼び出すためのものです。カスタムドックレットを呼び出すには、\-doclet および \-docletpath オプションを使用します。特定のドックレットを実行した完全な例については、 |
|
4662 .na |
5461 .na |
4663 「\f2Running the MIF Doclet\fP」 |
5462 \f2罔羣\fP @ |
4664 .fi |
5463 .fi |
4665 (http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet) を参照してください。 |
5464 http://java.sun.com/javase/6/docs/technotes/guides/javadoc/standard\-doclet.html#runningprogrammaticallyс |
4666 .LP |
5465 .LP |
4667 .SH "使用例" |
5466 .LP |
4668 .B javadoc |
5467 \f3絎茵\fP \- 筝荐茯罔羣 HTML 若喝冴с鴻帥若喝冴\-doclet \-docletpath 激с潟篏睡障劫絎茵絎箴ゃ |
4669 は、パッケージ全体に対して実行することも、 |
5468 .na |
4670 個々のソースファイルに対して実行することも |
5469 \f2MIF Doclet ャ<潟\fP @ |
4671 できます。各パッケージ名は、それぞれの |
5470 .fi |
4672 パッケージ名に対応するディレクトリ名を |
5471 http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.htmlс |
4673 持ちます。次の例では、ソースファイルは |
5472 .LP |
4674 .BR /home/src/java/awt/*java |
5473 .SH "膂≦箴" |
4675 にあります。生成先ディレクトリは |
5474 .LP |
4676 .BR /home/html |
5475 .LP |
4677 です。 |
5476 javadoc 宴若後篏絲障絎茵純若鴻<ゃ絲障絎茵с障宴若後宴若後絲上c<障罨<箴с純若鴻<ゃ \f2/home/src/java/awt/*.java\fP 障c \f2/home/html\fP с |
4678 .SS "1 つ以上のパッケージのドキュメント化" |
5477 .LP |
4679 パッケージをドキュメント化するには、その |
5478 .SS |
4680 パッケージのソースファイル (*\f3.java\f1) |
5479 1 や札筝宴若吾ャ<潟 |
4681 が、パッケージと同じ名前を持つディレクトリ |
5480 .LP |
4682 内に存在していなければなりません。 |
5481 .LP |
4683 パッケージ名が複数の識別子で構成されている |
5482 宴若吾ャ<潟宴若吾純若鴻<ゃ (\f2*.java\fP) 宴若吾ゃc絖違障宴若後茲違茘ュф (\f2java.awt.color\fP 茘ュу阪) 翫緇膓茘ュ筝篏泣c絲上違障 (\f2java/awt/color\fP )1 ゃ宴若吾茲違純若鴻<ゃ違贋 2 ゃc若主純с (\f2src1/java/awt/color\fP \f2src2/java/awt/color\fP ) 翫\f2\-sourcepath\fP c筝≧鴻贋絎違障 |
4684 (java.awt.color のように、各識別子はドットで |
5483 .LP |
4685 区切られている) 場合は、後続の各識別子が下位の |
5484 .LP |
4686 サブディレクトリに対応して |
5485 javadoc 絎茵\f2cd\fP 潟潟篏帥cc紊眼障 \f2\-sourcepath\fP 激с潟篏睡障篁ヤ箴с筝≧鴻号ゃ茯障 |
4687 いなければなりません (java/awt/color など)。 |
5486 .LP |
4688 1 つのパッケージのための複数のソースファイルを、 |
5487 .RS 3 |
4689 異なる場所にある 2 つのディレクトリツリーに分けて |
5488 .TP 2 |
4690 格納することも可能です |
5489 o |
4691 ( |
5490 \f3宴若 1 \- 1 や札筝宴若吾莎桁絽亥絎茵\fP \- 箴с javadoc 篁紙c絎茵с\-sourcepath 篏睡絽亥 \-subpackages (1.4 違激с) 篏睡障\f2java\fP 泣宴若 (\f2java.net\fP \f2java.lang\fP 若宴若吾ゃ) 障\f2java.lang\fP 泣宴若吾с \f2java.lang.ref\fP ゅ障 |
4692 .BR src1/java/awt/color |
5491 .nf |
4693 と |
5492 \f3 |
4694 .BR src2/java/awt/color |
5493 .fl |
4695 など)。 |
5494 % \fP\f3javadoc \fP\f3\-d\fP\f3 /home/html \fP\f3\-sourcepath\fP\f3 /home/src \fP\f3\-subpackages\fP\f3 java \fP\f3\-exclude\fP\f3 java.net:java.lang\fP |
4696 ただし、その場合は、\-sourcepath によって、 |
5495 .fl |
4697 その両方の場所を指定しなければなりません。 |
5496 .fi |
4698 .LP |
5497 .LP |
4699 .B javadoc |
5498 篁宴若吾若綏≦\f2java:javax:org.xml.sax\fP \f2\-subpackages\fP 綣違菴遵障 |
4700 を実行するには、cd コマンドを使って |
5499 .TP 2 |
4701 ディレクトリを変更するか、 |
5500 o |
4702 または |
5501 \f3宴若 2 \- 若純若鴻c腱祉c腓榊宴若吾絲障絎茵\fP \- 絎絎宴若後荀c腱祉障罨<ャ<潟 1 や札筝宴若後絎 javadoc 絎茵障 |
4703 .B \-sourcepath |
5502 .nf |
4704 オプションを使用します。 |
5503 \f3 |
4705 それぞれの例を次に示します。 |
5504 .fl |
4706 .TP 2 |
5505 % \fP\f3cd /home/src/\fP |
4707 \(bu |
5506 .fl |
4708 .B ケース 1 - 1 つ以上のパッケージからの起動を再帰的に実行 - |
5507 % \f3javadoc \-d /home/html java.awt java.awt.event\fP |
4709 この例では javadoc が任意のディレクトリから実行できるように、 |
5508 .fl |
4710 .BR \-sourcepath |
5509 .fi |
4711 を使用し、再帰的処理のために -subpackages (1.4 の新オプション) を使用します。 これは、java のサブパッケージ ( |
5510 .TP 2 |
4712 .BR java.net |
5511 o |
4713 および |
5512 \f3宴若 3 \- 篁紙c絎茵 純若鴻<ゃ 1 ゃc弱\fP \- 宴若鴻с憜cсc障障筝篏宴若吾荀c \f2\-sourcepath\fP 絎ャ<潟 1 や札筝宴若後絎 javadoc 絎茵障 |
4714 .BR java.lang |
5513 .nf |
4715 をルートとするパッケージを除く) を処理します。 |
5514 \f3 |
4716 これによって |
5515 .fl |
4717 .BR java.lang.ref ( |
5516 % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt java.awt.event\fP |
4718 .BR java.lang |
5517 .fl |
4719 のサブパッケージ) が |
5518 .fi |
4720 除外されることに注意してください。 |
5519 .TP 2 |
4721 .LP |
5520 o |
4722 .RS |
5521 \f3宴若 4 \- 篁紙c絎茵 純若鴻<ゃ茲違c弱\fP \- 宴若 3 篌若障宴若吾茲違c若絖障若若吾鴻 \f2\-sourcepath\fP 絎 (潟潟у阪)ャ<潟 1 や札筝宴若後絎 javadoc 絎茵障1 ゃ宴若吾鴻純若鴻<ゃ1 ゃ若c筝絖違障 純若鴻鴻絎贋цゃ医с |
4723 .ft 3 |
5522 .nf |
4724 .nf |
5523 \f3 |
4725 % javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude java.net:java.lang |
5524 .fl |
4726 .fi |
5525 % \fP\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java.awt java.awt.event\fP |
4727 .ft 1 |
5526 .fl |
4728 .RE |
5527 .fi |
4729 .LP |
5528 .RE |
4730 他のパッケージツリーを処理するには、 |
5529 |
4731 .BR java:javax:org.xml.sax |
5530 .LP |
4732 のように、その名前を |
5531 .LP |
4733 .BR \-subpackages |
5532 腟: 筝荐宴若鴻с\f2java.awt\fP \f2java.awt.event\fP 宴若後 public protected 鴻ゃ潟帥с若鴻ゃHTML 綵√ャ<潟絎c (\f2/home/html\fP) HTML <ゃ篆絖障2 や札筝宴若吾сャ<潟宴若吾鴻鴻鴻潟<ゃ潟鴻若吾 3 ゃ若ゃ障 |
4734 引数に追加します。 |
5533 .LP |
4735 .TP 2 |
5534 .SS |
4736 \(bu |
5535 1 や札筝鴻ャ<潟 |
4737 .B ケース 2 - ルートソースディレクトリに移ってから明示的なパッケージを実行 - |
5536 .LP |
4738 完全修飾パッケージの |
5537 .LP |
4739 親ディレクトリに移動します。 |
5538 障1 や札筝純若鴻<ゃ (\f2.java\fP) 羝<Javadoc 若絎茵с障javadoc 罨< 2 ゃ<号у茵с障 1 ゃ\f2cd\fP 潟潟сc紊眼号 1 ゃ \f2.java\fP <ゃ吾鴻絎絎号с後障鴻憜c莎欠鴻障純若鴻<ゃ羝<\f2\-sourcepath\fP 激с潟∴障≪鴻帥鴻 (*) 潟潟茵ゃ若篏睡鴻違若絎с障 |
4740 次に、ドキュメント化する |
5539 .LP |
4741 1 つ以上のパッケージ名を指定して |
5540 .RS 3 |
4742 .BR javadoc |
5541 .TP 2 |
4743 を実行します。 |
5542 o |
4744 .LP |
5543 \f3宴若 1 \- 純若鴻c腱祉\fP \- \f2.java\fP <ゃc腱祉障罨<ャ<潟 1 や札筝純若鴻<ゃ絎 javadoc 絎茵障 |
4745 .RS |
5544 .nf |
4746 .ft 3 |
5545 \f3 |
4747 .nf |
5546 .fl |
4748 % cd /home/src/ |
5547 % \fP\f3cd /home/src/java/awt\fP |
4749 % javadoc \-d /home/html java.awt java.awt.event |
5548 .fl |
4750 .fi |
5549 % \f3javadoc \-d /home/html Button.java Canvas.java Graphics*.java\fP |
4751 .ft 1 |
5550 .fl |
4752 .RE |
5551 .fi |
4753 .TP 2 |
5552 箴с \f2Button\fP \f2Canvas\fP喝 \f2Graphics\fP у障鴻ゃHTML 綵√ャ<潟障宴若後с純若鴻<ゃ javadoc 綣違羝<сャ<潟鴻鴻<ゃ潟若吾 2 ゃ若ゃ障 |
4754 \(bu |
5553 .TP 2 |
4755 .B ケース 3 - 任意のディレクトリから実行。ソースファイルは 1 つのディレクトリツリー内にある - このケースでは、現在のディレクトリがどこであってもかまいません。 トップレベルのパッケージの親ディレクトリを |
5554 o |
4756 .B \-sourcepath |
5555 \f3宴若 2 \- 宴若吾若c腱祉\fP \- 若茲違泣宴若吾純若鴻<ゃャ<潟翫箴水с宴若吾若c腱祉純若鴻<ゃ若鴻絎障 |
4757 に指定し、ドキュメント化する 1 つ以上のパッケージ名を指定して、 |
5556 .nf |
4758 .B javadoc |
5557 \f3 |
4759 を実行します。 |
5558 .fl |
4760 .LP |
5559 % \fP\f3cd /home/src/\fP |
4761 .RS |
5560 .fl |
4762 .ft 3 |
5561 % \f3javadoc \-d /home/html java/awt/Button.java java/applet/Applet.java\fP |
4763 .nf |
5562 .fl |
4764 % javadoc -d /home/html -sourcepath /home/src java.awt java.awt.event |
5563 .fi |
4765 .fi |
5564 箴с\f2Button\fP 鴻 \f2Applet\fP 鴻ゃHTML 綵√ャ<潟障 |
4766 .ft 1 |
5565 .TP 2 |
4767 .RE |
5566 o |
4768 .TP 2 |
5567 \f3宴若 3 \- 篁紙c\fP \- 宴若鴻с憜cсc障障ャ<潟 \f2.java\fP <ゃ吾腟九障 (障憜c後障) 絎 javadoc 絎茵障 |
4769 \(bu |
5568 .nf |
4770 .B ケース 4 - 任意のディレクトリから実行。ソースファイルは複数のディレクトリツリー内にある - これはケース 3 と似ていますが、パッケージが複数のディレクトリツリーに存在します。 各ツリーのルートへのパスを |
5569 \f3 |
4771 .B \-sourcepath |
5570 .fl |
4772 に指定し (コロンで区切る)、ドキュメント化する 1 つ以上のパッケージ名を指定して、javadoc を実行します。 1 つのパッケージのすべてのソースファイルが、1 つのルートディレクトリの下に存在しなければならない、ということはありません。ソースパスとして指定された場所のどこかで見付かれば十分です。 |
5571 % \fP\f3javadoc \-d /home/html /home/src/java/awt/Button.java /home/src/java/awt/Graphics*.java\fP |
4773 .LP |
5572 .fl |
4774 .RS |
5573 .fi |
4775 .ft 3 |
5574 箴с \f2Button\fP \f2Graphics\fP у障鴻ゃHTML 綵√ャ<潟障 |
4776 .nf |
5575 .RE |
4777 % javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java.awt java.awt.event |
5576 |
4778 .fi |
5577 .LP |
4779 .ft 1 |
5578 .SS |
4780 .RE |
5579 宴若吾鴻ャ<潟 |
4781 .LP |
5580 .LP |
4782 結果: どちらのケースでも、パッケージ |
5581 .LP |
4783 .B java.awt |
5582 宴若後篏鴻絎ャ<潟с障罨<菴違 2 ゃ箴腟水箴腓冴障\f2\-sourcepath\fP 宴若吾吾鴻絲障篏睡с障鴻鴻絲障篏睡с障 |
4784 と |
5583 .LP |
4785 .B java.awt.event |
5584 .nf |
4786 の public および protected |
5585 \f3 |
4787 なクラスとインタフェースを対象に、HTML 形式の |
5586 .fl |
4788 ドキュメントが生成され、指定 |
5587 % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt /home/src/java/applet/Applet.java\fP |
4789 された生成先ディレクトリ (\f3/home/html\f1) に HTML ファイルが |
5588 .fl |
4790 保存されます。2 つ |
5589 .fi |
4791 以上のパッケージが生成されるので、ドキュメントは、 |
5590 |
4792 パッケージのリスト、クラスのリスト、 |
5591 .LP |
4793 およびメインページの 3 つのフレームを持つことになります。 |
5592 .LP |
4794 .SS "1 つ以上のクラスのドキュメント化" |
5593 箴с宴若 \f2java.awt\fP \f2Applet\fP ゃHTML 綵√ャ<潟障Javadoc 若\f2Applet\fP 宴若後\f2Applet.java\fP 純若鴻<ゃ宴若後h (絎h翫) ゅャ障 |
4795 .B javadoc |
5594 .LP |
4796 ツールを実行する 2 番目の方法は、1 つ以上のソースファイル ( |
5595 .SH "篏睡箴" |
4797 .B .java |
5596 .LP |
4798 ) を渡すことです。 |
5597 .LP |
4799 .B javadoc |
5598 Javadoc 若紊箴水激с潟筝祉激с潟紫篏帥障х換篁Java 若 API 絲障 Javadoc 若絎茵篏睡絎潟潟сJava 2 Platform, Standard Edition, v1.2 絖膣 1500 public protected 鴻ゃャ<潟180M ゃ<≪若篏睡障 |
4800 は、次の 2 つのどちらかの方法で実行できます。 |
5599 .LP |
4801 1 つは、(cd によって) ディレクトリを |
5600 .LP |
4802 変更する方法、もう 1 つは |
5601 箴 2 イ莠障 箴潟潟茵絎茵с2 箴 Makefile 絎茵с激с潟綣違腟九障鴻篏睡篁紙c \f2javadoc\fP 潟潟絎茵с障 |
4803 .B .java |
5602 .LP |
4804 ファイルへのパスを完全指定する方法です。 |
5603 .SS |
4805 相対パスは、現在のディレクトリからの相対パスです。 |
5604 潟潟茵箴 |
4806 ソースファイルを渡した場合、 |
5605 .LP |
4807 .B \-sourcepath |
5606 .LP |
4808 オプションは無視されます。 |
5607 罨<潟潟茵箴 900 絖莇DOS 激с紊с障狗帥潟潟茵綣違<ゃ篏睡障 障激с鴻荐菴違障 |
4809 アスタリスク (*) の |
5608 .LP |
4810 ようなコマンド行ワイルドカードを使用すると、 |
5609 .nf |
4811 クラスのグループを指定できます。 |
5610 \f3 |
4812 .TP 2 |
5611 .fl |
4813 \(bu |
5612 % javadoc \-sourcepath /java/jdk/src/share/classes \\ |
4814 .B ケース 1 ソースディレクトリへの移動: |
5613 .fl |
4815 .B .java |
5614 \-overview /java/jdk/src/share/classes/overview.html \\ |
4816 ファイルのあるディレクトリに移動します。 |
5615 .fl |
4817 次に、ドキュメント化する 1 つ以上の |
5616 \-d /java/jdk/build/api \\ |
4818 ソースファイルの名前を指定して |
5617 .fl |
4819 .BR javadoc |
5618 \-use \\ |
4820 を実行します。 |
5619 .fl |
4821 .LP |
5620 \-splitIndex \\ |
4822 .RS |
5621 .fl |
4823 .ft 3 |
5622 \-windowtitle 'Java 2 Platform 5.0 API Specification' \\ |
4824 .nf |
5623 .fl |
4825 % cd /home/src/java/awt |
5624 \-doctitle 'Java(TM) 2 Platform 5.0 API Specification' \\ |
4826 % javadoc \-d /home/html Button.java Canvas.java Graphics*.java |
5625 .fl |
4827 .fi |
5626 \-header '<b>Java 2 Platform </b><br><font size="\-1">5.0</font>' \\ |
4828 .ft 1 |
|
4829 .RE |
|
4830 .LP |
|
4831 .RS 2 |
|
4832 この例では、クラス Button と Canvas、 |
|
4833 および先頭が Graphics で始まるクラスの |
|
4834 HTML 形式のドキュメントが生成されます。 |
|
4835 .BR javadoc |
|
4836 の引数として渡されているのは、 |
|
4837 パッケージ名ではなくソースファイルなので、 |
|
4838 ドキュメントは、クラスのリストと |
|
4839 メインページの 2 つのフレームを持つことになります。 |
|
4840 .RE |
|
4841 .TP 2 |
|
4842 \(bu |
|
4843 .B ケース 2 パッケージのルートディレクトリへの移動: |
|
4844 これは、同じルート内にある複数のサブパッケージのソースファイルを個々に |
|
4845 ドキュメント化する場合に便利です。パッケージの |
|
4846 ルートディレクトリに移動し、各ソースファイルを |
|
4847 ルートからのパスで指定します。 |
|
4848 .LP |
|
4849 .RS |
|
4850 .ft 3 |
|
4851 .nf |
|
4852 % cd /home/src/ |
|
4853 % javadoc \-d /home/html java/awt/Button.java java/applet/Applet.java |
|
4854 .fi |
|
4855 .ft 1 |
|
4856 .RE |
|
4857 .LP |
|
4858 .RS 2 |
|
4859 この例では、Button クラスおよび Applet クラス |
|
4860 用の HTML 形式のドキュメント |
|
4861 が生成されます。 |
|
4862 .RE |
|
4863 .TP 2 |
|
4864 \(bu |
|
4865 .B ケース 3 すべてのディレクトリから: |
|
4866 このケースでは、現在のディレクトリがどの |
|
4867 ディレクトリでも問題はありません。 |
|
4868 ドキュメント化する |
|
4869 .B .java |
|
4870 ファイルへの絶対パスまたは |
|
4871 相対パスを指定して |
|
4872 .BR javadoc |
|
4873 を実行します。 |
|
4874 .LP |
|
4875 .RS |
|
4876 .ft 3 |
|
4877 .nf |
|
4878 % javadoc \-d /home/html /home/src/java/awt/Button.java /home/src/java/awt/Graphics*.java |
|
4879 .fi |
|
4880 .ft 1 |
|
4881 .RE |
|
4882 .LP |
|
4883 .RS 2 |
|
4884 この例では、クラス |
|
4885 .B Button |
|
4886 および先頭が |
|
4887 .BR Graphics |
|
4888 で始まるクラスの HTML 形式 |
|
4889 のドキュメントが生成されます。 |
|
4890 .RE |
|
4891 .SS "パッケージとクラスのドキュメント化" |
|
4892 パッケージ全体と個々のクラスを同時にドキュメント |
|
4893 化できます。次に示すのは、上に示 |
|
4894 した 2 つの例を組み合わせた例です。 |
|
4895 .B \-sourcepath |
|
4896 は、パッケージへのパスに対しては使用できますが、 |
|
4897 個々のクラスのパスに対しては使用 |
|
4898 できません。 |
|
4899 .LP |
|
4900 .RS |
|
4901 .ft 3 |
|
4902 .nf |
|
4903 % javadoc \-d /home/html \-sourcepath /home/src java.awt /home/src/java/applet/Applet.java |
|
4904 .fi |
|
4905 .ft 1 |
|
4906 .RE |
|
4907 .LP |
|
4908 この例では、パッケージ |
|
4909 .B java.awt |
|
4910 とクラス |
|
4911 .B Applet |
|
4912 の HTML 形式のドキュメントが |
|
4913 生成されます。 |
|
4914 .B javadoc |
|
4915 は、Applet のパッケージ名を、 |
|
4916 .B Applet.java |
|
4917 ソースファイル内のパッケージの宣言 (宣言がある場合) から決定します。 |
|
4918 .SS "使用例" |
|
4919 .B javadoc |
|
4920 ツールには、多くの便利なオプションがあり、 |
|
4921 その中のいくつかは、ほかのオプションよりもよく |
|
4922 使われます。以下は、makefile 変数を使って Java プラット |
|
4923 フォーム API 上で |
|
4924 .B javadoc |
|
4925 ツールを実行するために使う効果的なコマンドです。 |
|
4926 ここでは 180M バイトのメモリを使用して、 |
|
4927 Java 2 Platform, Standard Edition, v1.2 に |
|
4928 存在する、約 1500 個の public および protected |
|
4929 クラスについてドキュメントを生成します。 |
|
4930 .LP |
|
4931 同じ例を 2 回掲載します。最初の例はコマンド行から実行するもので、2 番目の例は Makefile から実行するものです。 オプションの引数に絶対パスを使用しているため、任意のディレクトリからこの |
|
4932 .B javadoc |
|
4933 コマンドを実行できます。 |
|
4934 .SS コマンド行の例 |
|
4935 次のコマンド行の例は 900 文字を超えているため、 |
|
4936 DOS などのシェルには大きすぎます。 |
|
4937 この制限を回避するには、コマンド行 |
|
4938 引数ファイルを使用します。 |
|
4939 または、シェルスクリプトを記述します。 |
|
4940 .LP |
|
4941 .nf |
|
4942 \f3 |
|
4943 .fl |
|
4944 % javadoc \-sourcepath /java/jdk/src/share/classes \\ |
|
4945 .fl |
|
4946 \-overview /java/jdk/src/share/classes/overview.html \\ |
|
4947 .fl |
|
4948 \-d /java/jdk/build/api \\ |
|
4949 .fl |
|
4950 \-use \\ |
|
4951 .fl |
|
4952 \-splitIndex \\ |
|
4953 .fl |
|
4954 \-windowtitle 'Java 2 Platform 5.0 API Specification' \\ |
|
4955 .fl |
|
4956 \-doctitle 'Java<sup><font size="\-2">TM</font></sup> 2 Platform 5.0 API Specification' \\ |
|
4957 .fl |
|
4958 \-header '<b>Java 2 Platform </b><br><font size="\-1">5.0</font>' \\ |
|
4959 .fl |
5627 .fl |
4960 \-bottom '<font size="\-1"><a href="http://java.sun.com/cgi\-bin/bugreport.cgi">Submit |
5628 \-bottom '<font size="\-1"><a href="http://java.sun.com/cgi\-bin/bugreport.cgi">Submit |
4961 .fl |
5629 .fl |
4962 a bug or feature</a><br><br>Java is a trademark or registered trademark of Sun Microsystems, |
5630 a bug or feature</a><br><br>Java is a trademark or registered trademark of Sun Microsystems, |
4963 .fl |
5631 .fl |
4964 Inc. in the US and other countries.<br>Copyright 1993\-1999 Sun Microsystems, Inc. |
5632 Inc. in the US and other countries.<br>Copyright 1993\-1999 Sun Microsystems, Inc. |
4965 .fl |
5633 .fl |
4966 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. All Rights Reserved.</font>' \\ |
5634 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. All Rights Reserved.</font>' \\ |
4967 .fl |
5635 .fl |
4968 \-group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \\ |
5636 \-group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \\ |
4969 .fl |
5637 .fl |
4970 \-group "Extension Packages" "javax.*" \\ |
5638 \-group "Extension Packages" "javax.*" \\ |
4971 .fl |
5639 .fl |
4972 \-J\-Xmx180m \\ |
5640 \-J\-Xmx180m \\ |
4973 .fl |
5641 .fl |
4974 @packages |
5642 @packages |
4975 .fl |
5643 .fl |
4976 \fP |
5644 \fP |
4977 .fi |
5645 .fi |
4978 |
5646 |
4979 .LP |
5647 .LP |
4980 .LP |
5648 .LP |
4981 上記のコマンドで、packages は、 |
5649 筝荐潟潟с\f2packages\fP 絲乗院宴若後 (\f2java.applet java.lang\fP ) ャc<ゃс激с潟筝綣膃у蚊障綣違眼壕絖水ャс障違箴潟種若鴻翫\f2\-bottom\fP 激с潟壕絖ゃ羈с |
4982 処理対象のパッケージ名 ( |
5650 .LP |
4983 .BR java.applett |
5651 .SS |
4984 .BR java.lang など) が |
5652 Makefile 箴 |
4985 入っているファイルの名前です。 各オプションの、 |
5653 .LP |
4986 単一引用符で囲まれた引数の内側には、 |
5654 .LP |
4987 改行文字を挿入できません。 たとえば、 |
5655 сGNU Makefile 箴腓冴障Windows Makefile 箴ゃ |
4988 この例をコピー&ペーストする場合は、 |
|
4989 .B \-bottom |
|
4990 オプションから改行文字を削除してください。 |
|
4991 さらに、このあとの「注」も参照してください。 |
|
4992 .SS Makefile の例 |
|
4993 ここでは、GNU Makefile の例を示します。 |
|
4994 Windows の Makefile の例については、 |
|
4995 .na |
5656 .na |
4996 「\f2creating a makefile for Windows\fP」 |
5657 \f2Windows Makefile 篏号\fP @ |
4997 .fi |
5658 .fi |
4998 (http://java.sun.com/j2se/javadoc/faq/index.html#makefiles) を参照してください。 |
5659 http://java.sun.com/j2se/javadoc/faq/index.html#makefilesс |
4999 .LP |
5660 .LP |
5000 .nf |
5661 .nf |
5001 \f3 |
5662 \f3 |
5002 .fl |
5663 .fl |
5003 javadoc \-\fP\f3sourcepath\fP\f3 $(SRCDIR) \\ /* Sets path for source files */ |
5664 javadoc \-\fP\f3sourcepath\fP\f3 $(SRCDIR) \\ /* Sets path for source files */ |