." Copyright (c) 1994, 2011, Oracle and/or its affiliates. All rights reserved. ." .TH javadoc 1 "05 Jul 2012" .SH "åå‰" javadoc \- Java APIドã‚ュメント・ジェãƒãƒ¬ãƒ¼ã‚¿ .LP Javaソース・ファイルã‹ã‚‰ã€APIドã‚ュメントã®HTMLページを生æˆã—ã¾ã™ã€‚ã“ã®ãƒ‰ã‚ュメントã§ç´¹ä»‹ã•ã‚Œã¦ã„ã‚‹Javadocã®ä¾‹ã¯ã€Solarisを使用ã—ãŸå ´åˆã®ã‚‚ã®ã§ã™ã€‚ .SH "å½¢å¼" .LP \f4javadoc\fP\f2\ [\ \fP\f2options\fP\f2\ ]\ [\ packagenames\ ]\ [\ sourcefilenames\ ]\ [\ \-subpackages\fP\ \f2pkg1:pkg2:...\fP\f2\ ]\ [\ \fP\f2@argfiles\fP\f2\ ]\fP .LP 引数を指定ã™ã‚‹é †åºã¯ä»»æ„ã§ã™ã€‚Javadocツールã§ã®ã€å‡¦ç†å¯¾è±¡ã®\f2.java\fPファイルを決定ã™ã‚‹æ–¹æ³•ã®è©³ç´°ã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®å‡¦ç†ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .RS 3 .TP 3 options ã“ã®ãƒ‰ã‚ュメントã§èª¬æ˜Žã•ã‚Œã¦ã„るコマンドライン・オプションã§ã™ã€‚Javadocオプションã®æ¨™æº–çš„ãªä½¿ç”¨æ–¹æ³•ã«ã¤ã„ã¦ã¯ã€ä½¿ç”¨ä¾‹ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .TP 3 packagenames 空白文å—ã§åŒºåˆ‡ã‚‰ã‚ŒãŸä¸€é€£ã®ãƒ‘ッケージåã§ã™ã€‚ãŸã¨ãˆã°ã€\f2java.lang\ java.lang.reflect\ java.awt\fPã®ã‚ˆã†ã«æŒ‡å®šã—ã¾ã™ã€‚ドã‚ュメント化ã™ã‚‹ãƒ‘ッケージを個別ã«æŒ‡å®šã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ワイルドカードã¯ä½¿ç”¨ä¸å¯ã§ã™ã€‚å†å¸°çš„処ç†ã®ãŸã‚ã«ã¯ã€\-subpackagesを使用ã—ã¾ã™ã€‚Javadocツールã¯ã€\f2\-sourcepath\fPを使用ã—ã¦ã“れらã®ãƒ‘ッケージåを検索ã—ã¾ã™ã€‚例 \- 1ã¤ä»¥ä¸Šã®ãƒ‘ッケージã®ãƒ‰ã‚ュメント化をå‚ç…§ã—ã¦ãã ã•ã„。 .TP 3 sourcefilenames 空白文å—ã§åŒºåˆ‡ã‚‰ã‚ŒãŸä¸€é€£ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åã§ã™ã€‚å„ファイルã¯ã€ãƒ‘スã§å§‹ã¾ã‚Šã¾ã™ã€‚アスタリスク(*)ãªã©ã®ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚JavadocツールãŒå‡¦ç†ã™ã‚‹ã®ã¯ã€ãƒ•ã‚¡ã‚¤ãƒ«åãŒã€Œ.javaã€ã¨ã„ã†æ‹¡å¼µåã§çµ‚ã‚ã‚Šã€ãã®æ‹¡å¼µåを除ã„ãŸåå‰ãŒå®Ÿéš›ã«æœ‰åŠ¹ãªã‚¯ãƒ©ã‚¹åã§ã‚ã‚‹ã™ã¹ã¦ã®ãƒ•ã‚¡ã‚¤ãƒ«ã§ã™(Java言語仕様をå‚ç…§)。ã—ãŸãŒã£ã¦ã€ãƒã‚¤ãƒ•ãƒ³ã‚’å«ã‚€åå‰(\f2X\-Buffer\fPãªã©)ã‚„ã€ãã®ä»–ã®ç„¡åŠ¹ãªæ–‡å—ã‚’å«ã‚€åå‰ã‚’付ã‘ã‚‹ã“ã¨ã«ã‚ˆã£ã¦ã€ãれらã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’ドã‚ュメント化ã®å¯¾è±¡ã‹ã‚‰é™¤å¤–ã§ãã¾ã™ã€‚ã“ã‚Œã¯ã€ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚„テンプレート・ファイルã®å ´åˆã«ä¾¿åˆ©ã§ã™ã€‚ソース・ファイルåã®å‰ã«æŒ‡å®šã—ãŸãƒ‘スã«ã‚ˆã£ã¦ã€javadocãŒãã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’検索ã™ã‚‹å ´æ‰€ãŒæ±ºã¾ã‚Šã¾ã™ã€‚(Javadocツールã¯ã€ã“れらã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åを検索ã™ã‚‹ã¨ãã«\f2\-sourcepath\fPを使用\f2ã—ã¾ã›ã‚“\fP。)相対パスã¯ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’起点ã¨ã™ã‚‹ãŸã‚ã€\f2Button.java\fPを渡ã™ã“ã¨ã¯ã€\f2./Button.java\fPを渡ã™ã“ã¨ã¨åŒã˜ã§ã™ã€‚ソース・ファイルåをワイルドカードをå«ã‚€ãƒ•ãƒ«ãƒ‘スã§æŒ‡å®šã™ã‚‹ã¨ã€\f2/home/src/java/awt/Graphics*.java\fPã®ã‚ˆã†ã«ãªã‚Šã¾ã™ã€‚例 \- 1ã¤ä»¥ä¸Šã®ã‚¯ãƒ©ã‚¹ã®ãƒ‰ã‚ュメント化をå‚ç…§ã—ã¦ãã ã•ã„。ã¾ãŸã€ä¾‹ \- パッケージã¨ã‚¯ãƒ©ã‚¹ã®ãƒ‰ã‚ュメント化ã®ã‚ˆã†ã«ã€ãƒ‘ッケージåã¨ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åを混在ã•ã›ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚ .TP 3 \-subpackages pkg1:pkg2:... ソース・ファイルã‹ã‚‰æŒ‡å®šã•ã‚ŒãŸãƒ‘ッケージãŠã‚ˆã³ãã®ã‚µãƒ–パッケージ内ã«å†å¸°çš„ã«ãƒ‰ã‚ュメントを生æˆã—ã¾ã™ã€‚パッケージåã¾ãŸã¯ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åを指定ã™ã‚‹å¿…è¦ã¯ã‚ã‚Šã¾ã›ã‚“。 .TP 3 @argfiles Javadocオプションã€ãƒ‘ッケージåã€ãŠã‚ˆã³ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åã‚’ä»»æ„ã®é †åºã§ä¸¦ã¹ãŸãƒªã‚¹ãƒˆãŒå«ã¾ã‚Œã‚‹1ã¤ä»¥ä¸Šã®ãƒ•ã‚¡ã‚¤ãƒ«ã§ã™ã€‚ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã®ä¸ã§ã¯ã€ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰(*)ãŠã‚ˆã³\f2\-J\fPオプションã¯æŒ‡å®šã§ãã¾ã›ã‚“。 .RE .SH "説明" .LP \f3Javadoc\fPツールã¯ã€ä¸€é€£ã®Javaソース・ファイルã«ã‚る宣言ãŠã‚ˆã³ãƒ‰ã‚ュメンテーション・コメントを解æžã—ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã§ã¯publicクラスã€protectedクラスã€ãƒã‚¹ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹(匿åã®å†…部クラスã¯é™¤ã)ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ãŠã‚ˆã³ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã«ã¤ã„ã¦è¨˜è¿°ã—ãŸä¸€é€£ã®HTMLページを生æˆã—ã¾ã™ã€‚ã¾ãŸã€API(アプリケーション・プãƒã‚°ãƒ©ãƒŸãƒ³ã‚°ãƒ»ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹)ドã‚ュメントã®ç”Ÿæˆã‚„ã€ä¸€é€£ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®å®Ÿè£…ドã‚ュメントã®ç”Ÿæˆã«ä½¿ç”¨ã§ãã¾ã™ã€‚ .LP Javadocツールã¯ã€ãƒ‘ッケージ全体ã€å€‹ã€…ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã€ã¾ãŸã¯ãã®ä¸¡æ–¹ã«å¯¾ã—ã¦å®Ÿè¡Œã§ãã¾ã™ã€‚パッケージ全体ã®ãƒ‰ã‚ュメント化を行ã†ã«ã¯ã€\f2\-subpackages\fPを使用ã—ã¦æœ€ä¸Šä½ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰ä¸‹æ–¹ã«å†å¸°çš„ã«ãŸã©ã‚‹ã‹ã€ãƒ‘ッケージåã®æ˜Žç¤ºçš„ãªãƒªã‚¹ãƒˆã‚’渡ã—ã¾ã™ã€‚個々ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®ãƒ‰ã‚ュメント化を行ã†ã«ã¯ã€ã‚½ãƒ¼ã‚¹(.\f2.java\fP)ファイルåã®ãƒªã‚¹ãƒˆã‚’渡ã—ã¾ã™ã€‚具体的ãªä¾‹ã¯ã€ã“ã®ãƒ‰ã‚ュメントã®æœ€å¾Œã«ç´¹ä»‹ã—ã¾ã™ã€‚次ã«ã€Javadocã«ã‚ˆã‚‹ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®å‡¦ç†ã«ã¤ã„ã¦èª¬æ˜Žã—ã¾ã™ã€‚ .SS ソース・ファイルã®å‡¦ç† .LP Javadocツールã¯ã€æœ«å°¾ãŒã€Œ\f2.java\fPã€ã®ãƒ•ã‚¡ã‚¤ãƒ«ä»¥å¤–ã«ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã§è¨˜è¿°ã•ã‚Œã¦ã„ã‚‹ä»–ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚‚処ç†ã—ã¾ã™ã€‚個々ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åを明示的ã«æ¸¡ã—ã¦Javadocツールを実行ã™ã‚‹å ´åˆã€ã©ã®\f2.java\fPファイルを処ç†ã™ã‚‹ã‹ã‚’æ£ç¢ºã«æŒ‡å®šã§ãã¾ã™ã€‚ãŸã ã—ã€å¤šãã®é–‹ç™ºè€…ã¯ã“ã®æ–¹æ³•ã§ã¯ä½œæ¥ã—ã¾ã›ã‚“。パッケージåを渡ã™ã»ã†ãŒç°¡å˜ã ã‹ã‚‰ã§ã™ã€‚ソース・ファイルåを明示的ã«æŒ‡å®šã—ãªãã¦ã‚‚ã€Javadocツールã¯3ã¤ã®æ–¹æ³•ã§å®Ÿè¡Œã§ãã¾ã™ã€‚ãã‚Œã¯ã€(1)パッケージåを渡ã™ã€(2)\f2\-subpackages\fPを使用ã™ã‚‹ã€(3)ソース・ファイルåã§ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰ã‚’使用ã™ã‚‹(\f2*.java\fP)ã€ã¨ã„ã†æ–¹æ³•ã§ã™ã€‚ã“れらã®å ´åˆã€JavadocツールãŒ\f2.java\fPファイルã®å‡¦ç†ã‚’è¡Œã†ã®ã¯ã€ãã®ãƒ•ã‚¡ã‚¤ãƒ«ãŒæ¬¡ã®ã™ã¹ã¦ã®è¦ä»¶ã‚’満ãŸã™å ´åˆã®ã¿ã§ã™ã€‚ .RS 3 .TP 2 o 接尾辞「\f2.java\fPã€ã‚’除ã„ãŸåå‰ãŒå®Ÿéš›ã«æœ‰åŠ¹ãªã‚¯ãƒ©ã‚¹åã§ã‚ã‚‹å ´åˆ(有効ãªæ–‡å—ã«ã¤ã„ã¦ã¯ã€Java言語仕様をå‚ç…§) .TP 2 o ソース・ツリーã®ãƒ«ãƒ¼ãƒˆã‹ã‚‰ç›¸å¯¾çš„ãªãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªãƒ»ãƒ‘スãŒã€åŒºåˆ‡ã‚Šæ–‡å—をドットã«å¤‰æ›ã™ã‚‹ã¨ã€å®Ÿéš›ã«æœ‰åŠ¹ãªãƒ‘ッケージåã§ã‚ã‚‹å ´åˆ .TP 2 o packageæ–‡ã«æœ‰åŠ¹ãªãƒ‘ッケージå(å‰ç®‡æ¡æ›¸ãã§æŒ‡å®š)ãŒå«ã¾ã‚Œã‚‹å ´åˆ .RE .LP \f3リンクã®å‡¦ç†\fP \- Javadocツールã¯ã€å‡¦ç†ã®å®Ÿè¡Œä¸ã«ã€ãã®å®Ÿè¡Œã§ãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ãŠã‚ˆã³ãƒ¡ãƒ³ãƒãƒ¼ã®åå‰ã«å¯¾ã—ã¦ã€è‡ªå‹•çš„ã«ç›¸äº’å‚ç…§ãƒªãƒ³ã‚¯ã‚’è¿½åŠ ã—ã¾ã™ã€‚ã“ã®ã‚ˆã†ãªãƒªãƒ³ã‚¯ã¯ã€æ¬¡ã®ã‚ˆã†ãªå ´æ‰€ã«è¿½åŠ ã•ã‚Œã¾ã™ã€‚ .RS 3 .TP 2 o 宣言(戻り値ã®åž‹ã€å¼•æ•°ã®åž‹ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®åž‹) .TP 2 o \f2@see\fPã‚¿ã‚°ã‹ã‚‰ç”Ÿæˆã•ã‚ŒãŸã€Œé–¢é€£é …ç›®ã€ã‚»ã‚¯ã‚·ãƒ§ãƒ³ .TP 2 o \f2{@link}\fPã‚¿ã‚°ã‹ã‚‰ç”Ÿæˆã•ã‚ŒãŸã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ãƒ†ã‚スト .TP 2 o \f2@throws\fPã‚¿ã‚°ã‹ã‚‰ç”Ÿæˆã•ã‚ŒãŸä¾‹å¤–ã®åå‰ .TP 2 o インタフェースã®ãƒ¡ãƒ³ãƒãƒ¼ã«å¯¾ã™ã‚‹ã€Œå®šç¾©ã€ãƒªãƒ³ã‚¯ã¨ã€ã‚¯ãƒ©ã‚¹ã®ãƒ¡ãƒ³ãƒãƒ¼ã«å¯¾ã™ã‚‹ã€Œã‚ªãƒ¼ãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã€ãƒªãƒ³ã‚¯ .TP 2 o パッケージã€ã‚¯ãƒ©ã‚¹ã€ãŠã‚ˆã³ãƒ¡ãƒ³ãƒãƒ¼ã‚’リストã—ã¦ã„る概è¦è¡¨ .TP 2 o パッケージãŠã‚ˆã³ã‚¯ãƒ©ã‚¹ã®ç¶™æ‰¿ãƒ„リー .TP 2 o 索引 .RE .LP コマンドラインã§æŒ‡å®šã—ãªã‹ã£ãŸã‚¯ãƒ©ã‚¹ã«ã¤ã„ã¦ã®æ—¢å˜ã®ãƒ†ã‚スト(別ã«ç”Ÿæˆã—ãŸãƒ†ã‚スト)ã«å¯¾ã—ã¦ãƒã‚¤ãƒ‘ãƒ¼ãƒªãƒ³ã‚¯ã‚’è¿½åŠ ã™ã‚‹ã«ã¯ã€\f2\-link\fPãŠã‚ˆã³\f2\-linkoffline\fPオプションを利用ã§ãã¾ã™ã€‚ .LP \f3ãã®ä»–ã®å‡¦ç†ã«ã¤ã„ã¦ã®è©³ç´°\fP \- Javadocツールã¯ã€å®Ÿè¡Œã™ã‚‹ãŸã³ã«1ã¤ã®å®Œå…¨ãªãƒ‰ã‚ュメントを作æˆã—ã¾ã™ã€‚ドã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’è¿½åŠ ç”Ÿæˆã™ã‚‹ã“ã¨ã¯ã§ãã¾ã›ã‚“。ã¤ã¾ã‚Šã€Javadocツールã®ä»¥å‰ã®å®Ÿè¡Œçµæžœã‚’ä¿®æ£ã—ãŸã‚Šã€ãã®å†…容を\f2直接\fP組ã¿å…¥ã‚ŒãŸã‚Šã™ã‚‹ã“ã¨ã¯ã§ãã¾ã›ã‚“。ãŸã ã—ã€å‰è¿°ã®ã‚ˆã†ã«ã€ä»–ã®å®Ÿè¡Œçµæžœã«ãƒªãƒ³ã‚¯ã™ã‚‹ã“ã¨ã¯ã§ãã¾ã™ã€‚ .LP 実装上ã®ç†ç”±ã‹ã‚‰ã€Javadocツールã¯ã€ã‚¸ãƒ§ãƒ–を実行ã™ã‚‹ãŸã‚ã«javaコンパイラを必è¦ã¨ã—ã€javaコンパイラã«ä¾å˜ã—ã¦ã„ã¾ã™ã€‚Javadocツールã¯ã€\f2javac\fPã®ä¸€éƒ¨ã‚’呼ã³å‡ºã—ã¦å®£è¨€ã‚’コンパイルã—ã¾ã™ãŒã€ãƒ¡ãƒ³ãƒãƒ¼ã®å®Ÿè£…ã¯ç„¡è¦–ã—ã¾ã™ã€‚ã“ã‚Œã¯ã€ã‚¯ãƒ©ã‚¹éšŽå±¤ã‚’å«ã‚€ã‚¯ãƒ©ã‚¹ã®è±Šå¯Œãªå†…部表ç¾ã¨ã‚¯ãƒ©ã‚¹ã®ã€Œä½¿ç”¨ã€é–¢ä¿‚を構築ã—ã€ãã®æƒ…å ±ã‹ã‚‰HTMLを生æˆã—ã¾ã™ã€‚ã•ã‚‰ã«ã€Javadocツールã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã®ãƒ‰ã‚ュメンテーション・コメントã‹ã‚‰ã€ãƒ¦ãƒ¼ã‚¶ãƒ¼ã®æä¾›ã—ãŸãƒ‰ã‚ュメントもå–å¾—ã—ã¾ã™ã€‚ .LP 実際ã«ã¯ã€Javadocツールã¯ã€ãƒ¡ã‚½ãƒƒãƒ‰æœ¬ä½“ã‚’æŒãŸãªã„純粋ãªã‚¹ã‚¿ãƒ–・ファイルã§ã‚ã‚‹\f2.java\fPソース・ファイルã«å¯¾ã—ã¦ã‚‚実行ã§ãã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€APIã®ä½œæˆæ™‚ã«ã¯ã€å®Ÿè£…を記述ã™ã‚‹å‰ã®è¨è¨ˆã®æ—©ã„段階ã§ã€ãƒ‰ã‚ュメンテーション・コメントを記述ã—ã¦javadocツールを実行ã§ãã¾ã™ã€‚ .LP コンパイラã«ä¾å˜ã™ã‚‹ã“ã¨ã«ã‚ˆã£ã¦ã€HTML出力ã¯ã€å®Ÿéš›ã®å®Ÿè£…ã«æ£ç¢ºã«å¯¾å¿œã—ã¾ã™ã€‚実際ã®å®Ÿè£…ã¯ã€æ˜Žç¤ºçš„ãªã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã«ã§ã¯ãªãã€æš—é»™ã®ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã«ä¾å˜ã™ã‚‹å ´åˆãŒã‚ã‚Šã¾ã™ã€‚ãŸã¨ãˆã°ã€Javadocツールã¯ã€\f2.class\fPファイルã«ã¯å˜åœ¨ã™ã‚‹ãŒã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã«ã¯å˜åœ¨ã—ãªã„デフォルト・コンストラクタ(Java言語仕様をå‚ç…§)をドã‚ュメント化ã—ã¾ã™ã€‚ .LP 通常ã€Javadocツールã§ã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®ã‚³ãƒ¼ãƒ‰ãŒä¸å®Œå…¨ã¾ãŸã¯ã‚¨ãƒ©ãƒ¼ã‚’å«ã‚“ã§ã„ã‚‹å ´åˆã§ã‚‚ドã‚ュメントを生æˆã§ãã¾ã™ã€‚ã“ã®ãŸã‚ã€ãƒ‡ãƒãƒƒã‚°ã‚„トラブルシューティングを完了ã™ã‚‹å‰ã«ãƒ‰ã‚ュメントを生æˆã§ãã¾ã™ã€‚ãŸã¨ãˆã°ã€\f2Java言語仕様\fPã«ã‚ˆã‚‹ã¨ã€æŠ½è±¡ãƒ¡ã‚½ãƒƒãƒ‰ã‚’å«ã‚€ã‚¯ãƒ©ã‚¹ã¯ã€ãれ自体を抽象ã¨ã—ã¦å®£è¨€ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚javacコンパイラã¯ã“ã®ã‚¨ãƒ©ãƒ¼ã‚’検出ã™ã‚‹ã¨åœæ¢ã—ã¾ã™ãŒã€Javadocツールã¯ã“ã®ãƒã‚§ãƒƒã‚¯ã‚’è¡Œã‚ãšã€è¦å‘Šã‚’出ã•ãšã«å‡¦ç†ã‚’続行ã—ã¾ã™ã€‚Javadocツールã¯ãƒ‰ã‚ュメンテーション・コメントã®åŸºæœ¬çš„ãªãƒã‚§ãƒƒã‚¯ã‚’è¡Œã„ã¾ã™ã€‚ドã‚ュメンテーション・コメントをより詳ã—ããƒã‚§ãƒƒã‚¯ã™ã‚‹å¿…è¦ãŒã‚ã‚‹å ´åˆã¯ã€DocCheckドックレットを使用ã—ã¦ãã ã•ã„。 .LP Javadocツールã¯ã€ãƒ‰ã‚ュメントã®å†…éƒ¨æ§‹é€ ã‚’æ§‹ç¯‰ã™ã‚‹éš›ã€å‚照クラスをã™ã¹ã¦ãƒãƒ¼ãƒ‰ã—ã¾ã™ã€‚ã“ã®ãŸã‚ã€Javadocツールã¯ã€ãƒ–ートストラップ・クラスã€æ‹¡å¼µæ©Ÿèƒ½ã€ã¾ãŸã¯ãƒ¦ãƒ¼ã‚¶ãƒ¼ãƒ»ã‚¯ãƒ©ã‚¹ã«ã‹ã‹ã‚らãšã€ã™ã¹ã¦ã®å‚照クラスを検索ã§ãã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚詳細ã¯ã€ .na \f2クラスã®æ¤œç´¢æ–¹æ³•\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/tools/findingclasses.htmlã‚’å‚ç…§ã—ã¦ãã ã•ã„。通常ã€ä½œæˆã™ã‚‹ã‚¯ãƒ©ã‚¹ã¯ã€æ‹¡å¼µæ©Ÿèƒ½ã¨ã—ã¦ãƒãƒ¼ãƒ‰ã™ã‚‹ã‹ã€Javadocツールã®ã‚¯ãƒ©ã‚¹ãƒ»ãƒ‘ス内ã«ç½®ãå¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .SS Javadocã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆ .LP Javadocツールã®å‡ºåŠ›ã®å†…容ã¨å½¢å¼ã¯ã€ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã‚’使用ã—ã¦ã‚«ã‚¹ã‚¿ãƒžã‚¤ã‚ºã§ãã¾ã™ã€‚Javadocツールã«ã¯ã€æ¨™æº–ドックレットã¨å‘¼ã°ã‚Œã‚‹ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®ã€Œçµ„è¾¼ã¿ã€ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆãŒã‚ã‚Šã¾ã™ã€‚標準ドックレットã¯ã€HTMLå½¢å¼ã®APIドã‚ュメントを生æˆã—ã¾ã™ã€‚標準ドックレットを修æ£ã¾ãŸã¯ã‚µãƒ–クラス化ã™ã‚‹ã“ã¨ã‚„ã€HTMLã€XMLã€MIFã€RTFãªã©ã®å¥½ã¿ã®å‡ºåŠ›å½¢å¼ã‚’生æˆã™ã‚‹ç‹¬è‡ªã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã‚’記述ã™ã‚‹ã“ã¨ã‚‚å¯èƒ½ã§ã™ã€‚ドックレットã¨ãã®ä½¿ç”¨æ–¹æ³•ã«ã¤ã„ã¦ã¯ã€æ¬¡ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .RS 3 .TP 2 o .na \f2Javadocã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆ\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html .TP 2 o \f2\-doclet\fPコマンドライン・オプション .RE .LP \f2\-doclet\fPコマンドライン・オプションã§ã‚«ã‚¹ã‚¿ãƒ ・ドックレットãŒæŒ‡å®šã•ã‚Œã¦ã„ãªã„å ´åˆã€Javadocツールã¯ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®æ¨™æº–ドックレットを使用ã—ã¾ã™ã€‚javadocツールã«ã¯ã€ä½¿ç”¨ã•ã‚Œã¦ã„るドックレットã«é–¢ä¿‚ãªã使用ã§ãるコマンドライン・オプションãŒã‚ã‚Šã¾ã™ã€‚標準ドックレットã§ã¯ã€ã“れらã®ä»–ã«ã€ã„ãã¤ã‹ã®ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ãƒ»ã‚ªãƒ—ションãŒè¿½åŠ ã•ã‚Œã¾ã™ã€‚ã©ã¡ã‚‰ã®ã‚ªãƒ—ションã«ã¤ã„ã¦ã‚‚ã€å¾Œè¿°ã®ã‚ªãƒ—ションã§èª¬æ˜Žã—ã¾ã™ã€‚ .SS 関連ドã‚ュメントãŠã‚ˆã³ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆ .RS 3 .TP 2 o .na \f2Javadocã«æ–½ã•ã‚ŒãŸæ‹¡å¼µæ©Ÿèƒ½\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/index.html \- Javadocã§è¿½åŠ ã•ã‚ŒãŸæ”¹è‰¯ç‚¹ã®è©³ç´°ã€‚ .TP 2 o .na \f2Javadoc FAQ\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137483.html \- é »ç¹ã«å¯„ã›ã‚‰ã‚Œã‚‹è³ªå•ã«å¯¾ã™ã‚‹å›žç”ã€Javadoc関連ã®ãƒ„ールã«ã¤ã„ã¦ã®æƒ…å ±ã€ãŠã‚ˆã³ãƒã‚°ã®å›žé¿æ–¹æ³•ã€‚ .TP 2 o .na \f2How to Write Doc Comments for Javadoc\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html \- ドã‚ュメンテーション・コメントã®è¨˜è¿°æ–¹æ³•ã«é–¢ã™ã‚‹Sunã®è¦ç´„。 .TP 2 o .na \f2API仕様を記述ã™ã‚‹ãŸã‚ã®è¦ä»¶\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-142372.html \- Java SEプラットフォーム仕様を記述ã™ã‚‹éš›ã«ä½¿ç”¨ã•ã‚ŒãŸæ¨™æº–è¦ä»¶ã€‚ã“ã®æƒ…å ±ã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®ãƒ‰ã‚ュメンテーション・コメント形å¼ã§API仕様を記述ã™ã‚‹å ´åˆã«ã‚‚ã€ãã®ä»–ã®å½¢å¼ã§è¨˜è¿°ã™ã‚‹å ´åˆã«ã‚‚役立ã¡ã¾ã™ã€‚検証å¯èƒ½ãªã‚¢ã‚µãƒ¼ã‚·ãƒ§ãƒ³ã‚’満ãŸã™ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã€ãŠã‚ˆã³ãƒ¡ã‚½ãƒƒãƒ‰ã«ã¤ã„ã¦ã®è¦ä»¶ã‚’定ã‚ã¦ã„ã¾ã™ã€‚ .TP 2 o .na \f2ドã‚ュメンテーション・コメントã®ä»•æ§˜\fP @ .fi http://docs.oracle.com/javase/specs/ \- ドã‚ュメンテーション・コメントã®ã‚ªãƒªã‚¸ãƒŠãƒ«ä»•æ§˜ã«ã¤ã„ã¦ã¯ã€\f2Java Language Specification\fP (James Goslingã€Bill Joyã€Guy Steele共著)ã®åˆç‰ˆã®ç¬¬18ç« ã€Documentation Commentsã‚’å‚ç…§ã—ã¦ãã ã•ã„。(ã“ã®ç« ã¯ã€ç¬¬2版ã§ã¯å‰Šé™¤ã•ã‚Œã¾ã—ãŸã€‚) .TP 2 o .na \f2DocCheckドックレット\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-141437.html \- ソース・ファイル内ã®ãƒ‰ã‚ュメンテーション・コメントをãƒã‚§ãƒƒã‚¯ã—ã€æ¤œå‡ºã•ã‚ŒãŸã‚¨ãƒ©ãƒ¼ã‚„ä¸æ£ã®ãƒ¬ãƒãƒ¼ãƒˆã‚’生æˆã—ã¾ã™ã€‚Doc Checkユーティリティã®ä¸€éƒ¨ã§ã™ã€‚ .RE .SS 用語 .LP \f2ドã‚ュメンテーション・コメント\fPã€\f2docコメント\fPã€\f2主説明\fPã€\f2ã‚¿ã‚°\fPã€\f2ブãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°\fPã€ãŠã‚ˆã³\f2インライン・タグ\fPã®ç”¨èªžã«ã¤ã„ã¦ã¯ã€ãƒ‰ã‚ュメンテーション・コメントã§èª¬æ˜Žã—ã¾ã™ã€‚次ã®ãã®ä»–ã®ç”¨èªžã¯ã€Javadocツールã®ã‚³ãƒ³ãƒ†ã‚ストã§ç‰¹å®šã®æ„味をæŒã¡ã¾ã™ã€‚ .RS 3 .TP 3 生æˆãƒ‰ã‚ュメント(generated document) JavadocツールãŒJavaソース・コード内ã®ãƒ‰ã‚ュメンテーション・コメントã‹ã‚‰ç”Ÿæˆã—ãŸãƒ‰ã‚ュメントã®ã“ã¨ã§ã™ã€‚デフォルトã®ç”Ÿæˆãƒ‰ã‚ュメントã¯HTMLå½¢å¼ã§ã€æ¨™æº–ドックレットã«ã‚ˆã£ã¦ä½œæˆã•ã‚Œã¾ã™ã€‚ .LP .TP 3 åå‰(name) Java言語ã§æ›¸ã‹ã‚ŒãŸãƒ—ãƒã‚°ãƒ©ãƒ è¦ç´ ã®åå‰ã€ã¤ã¾ã‚Šãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ã¾ãŸã¯ãƒ¡ã‚½ãƒƒãƒ‰ã®åå‰ã®ã“ã¨ã§ã™ã€‚åå‰ã¯ã€\f2java.lang.String.equals(java.lang.Object)\fPã®ã‚ˆã†ãªå®Œå…¨ä¿®é£¾åã«ã™ã‚‹ã“ã¨ã‚‚ã€\f2equals(Object)\fPã®ã‚ˆã†ãªéƒ¨åˆ†ä¿®é£¾åã«ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚ .LP .TP 3 ドã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹(documented classes) Javadocã®å®Ÿè¡Œã«ã‚ˆã£ã¦è©³ç´°ãªãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ã“ã¨ã§ã™ã€‚ドã‚ュメント化ã™ã‚‹ã«ã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒä½¿ç”¨å¯èƒ½ã§ã‚ã‚Šã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åã¾ãŸã¯ãƒ‘ッケージåã‚’javadocコマンドã«æ¸¡ã™å¿…è¦ãŒã‚ã‚Šã€ã‚¢ã‚¯ã‚»ã‚¹ä¿®é£¾å(publicã€protectedã€package\-privateã¾ãŸã¯private)ã«ã‚ˆã£ã¦ãƒ•ã‚£ãƒ«ã‚¿å‡¦ç†ã•ã‚Œãªã„よã†ã«ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ドã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ã¯ã€javadocツールã®å‡ºåŠ›ã«çµ„ã¿è¾¼ã¾ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ã€ã¤ã¾ã‚Š\f2包å«ã‚¯ãƒ©ã‚¹\fPã¨ã‚‚呼ã°ã‚Œã¾ã™ã€‚ .LP .TP 3 包å«ã‚¯ãƒ©ã‚¹(included classes) Javadocツールã®å®Ÿè¡Œã«ã‚ˆã£ã¦è©³ç´°ãªãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ã“ã¨ã§ã™ã€‚\f2ドã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹\fPã¨åŒã˜ã§ã™ã€‚ .LP .TP 3 除外クラス(excluded classes) Javadocツールã®å®Ÿè¡Œã«ã‚ˆã£ã¦è©³ç´°ãªãƒ‰ã‚ュメントãŒç”Ÿæˆ\f2ã•ã‚Œãªã„\fPクラスãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ã“ã¨ã§ã™ã€‚ .LP .TP 3 å‚照クラス(referenced classes) ドã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®å®šç¾©(実装)ã¾ãŸã¯ãƒ‰ã‚ュメンテーション・コメントã®ä¸ã§æ˜Žç¤ºçš„ã«å‚ç…§ã•ã‚Œã¦ã„るクラスãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ã“ã¨ã§ã™ã€‚å‚ç…§ã®ä¾‹ã¨ã—ã¦ã¯ã€æˆ»ã‚Šå€¤ã®åž‹ã€ãƒ‘ラメータã®åž‹ã€ã‚ャストã®åž‹ã€æ‹¡å¼µã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã€å®Ÿè£…ã•ã‚ŒãŸã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚¤ãƒ³ãƒãƒ¼ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã€ãƒ¡ã‚½ãƒƒãƒ‰æœ¬ä½“ã§ä½¿ç”¨ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ã€@seeã€{@link}ã€{@linkplain}ã€{@inheritDoc}ã‚¿ã‚°ãªã©ãŒã‚ã‚Šã¾ã™ã€‚(ã“ã®å®šç¾©ã¯ .na \f21.3\fP @ .fi http://docs.oracle.com/javase/1.3/docs/tooldocs/solaris/javadoc.html#referencedclassesã‹ã‚‰å¤‰æ›´ã•ã‚Œã¦ã„ã‚‹ã“ã¨ã«æ³¨æ„ã—ã¦ãã ã•ã„。)Javadocツールを実行ã™ã‚‹ã¨ãã¯ã€Javadocã®ãƒ–ート・クラスパスãŠã‚ˆã³ã‚¯ãƒ©ã‚¹ãƒ‘ス内ã«ã‚ã‚‹ã™ã¹ã¦ã®å‚照クラスをメモリーã«ãƒãƒ¼ãƒ‰ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚(å‚照クラスãŒè¦‹ã¤ã‹ã‚‰ãªã„å ´åˆã¯ã€ã€Œã‚¯ãƒ©ã‚¹ãŒè¦‹ã¤ã‹ã‚Šã¾ã›ã‚“ã€ã¨ã„ã†è¦å‘ŠãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚)Javadocツールã¯ã€ã‚¯ãƒ©ã‚¹ã®å˜åœ¨ã¨ãã®ãƒ¡ãƒ³ãƒãƒ¼ã®å®Œå…¨ä¿®é£¾åを判別ã™ã‚‹ã®ã«å¿…è¦å分ãªæƒ…å ±ã‚’ã€.classファイルã‹ã‚‰å¼•ã出ã™ã“ã¨ãŒã§ãã¾ã™ã€‚ .LP .TP 3 外部å‚照クラス(external referenced classes) å‚照クラスã®ã†ã¡ã€Javadocã®å®Ÿè¡Œä¸ã«ãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œãªã„クラスã®ã“ã¨ã§ã™ã€‚ã¤ã¾ã‚Šã€ã“れらã®ã‚¯ãƒ©ã‚¹ã¯ã€ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã§Javadocツールã«æ¸¡ã•ã‚Œã¦ã„ã¾ã›ã‚“。生æˆãƒ‰ã‚ュメント内ã§ã“れらã®ã‚¯ãƒ©ã‚¹ã«ãƒªãƒ³ã‚¯ã—ã¦ã„る箇所ã¯ã€\f2外部å‚ç…§\fPã¾ãŸã¯\f2外部リンク\fPã¨å‘¼ã°ã‚Œã¾ã™ã€‚ãŸã¨ãˆã°ã€\f2java.awt\fPパッケージã«å¯¾ã—ã¦ã®ã¿Javadocツールを実行ã—ãŸå ´åˆã€\f2Object\fPãªã©ã®\f2java.lang\fP内ã®ã™ã¹ã¦ã®ã‚¯ãƒ©ã‚¹ãŒå¤–部å‚照クラスã«ãªã‚Šã¾ã™ã€‚外部å‚照クラスã«ãƒªãƒ³ã‚¯ã™ã‚‹ã«ã¯ã€\f2\-link\fPãŠã‚ˆã³\f2\-linkoffline\fPオプションを使用ã—ã¾ã™ã€‚外部å‚照クラスã«ã¯ã€é€šå¸¸ãã®ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã‚’Javadocツールã®å®Ÿè¡Œã§åˆ©ç”¨ã§ããªã„ã¨ã„ã†é‡è¦ãªç‰¹å¾´ãŒã‚ã‚Šã¾ã™ã€‚ã“ã®å ´åˆã€ãれらã®ã‚³ãƒ¡ãƒ³ãƒˆã‚’継承ã™ã‚‹ã“ã¨ã¯ã§ãã¾ã›ã‚“。 .RE .SH "ソース・ファイル" .LP Javadocツールã¯ã€4ã¤ã®ã‚¿ã‚¤ãƒ—ã®ç•°ãªã‚‹ã€Œã‚½ãƒ¼ã‚¹ã€ãƒ•ã‚¡ã‚¤ãƒ«ã‹ã‚‰å‡ºåŠ›ã‚’生æˆã—ã¾ã™ã€‚ãã®ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€ã‚¯ãƒ©ã‚¹ã®Java言語ソース・ファイル(\f2.java\fP)ã€ãƒ‘ッケージ・コメント・ファイルã€æ¦‚è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã€ãŠã‚ˆã³ãã®ä»–ã®æœªå‡¦ç†ã®ãƒ•ã‚¡ã‚¤ãƒ«ã§ã™ã€‚ã“ã“ã§ã¯ã€ãƒ‰ã‚ュメント化ã—ãªã„ãŒã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーã«å˜åœ¨ã™ã‚‹å ´åˆãŒã‚るテスト・ファイルやテンプレート・ファイルã«ã¤ã„ã¦ã‚‚説明ã—ã¾ã™ã€‚ .SS クラス・ソース・コード・ファイル .LP ãã‚Œãžã‚Œã®ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ãŠã‚ˆã³ãã®ãƒ¡ãƒ³ãƒãƒ¼ã¯ã€ç‹¬è‡ªã®ãƒ‰ã‚ュメンテーション・コメントをæŒã¤ã“ã¨ãŒã§ãã€ãれを\f2.java\fPファイル内ã«ä¿æŒã—ã¾ã™ã€‚ドã‚ュメンテーション・コメントã®è©³ç´°ã¯ã€ãƒ‰ã‚ュメンテーション・コメントをå‚ç…§ã—ã¦ãã ã•ã„。 .SS パッケージ・コメント・ファイル .LP ãã‚Œãžã‚Œã®ãƒ‘ッケージã¯ã€ç‹¬è‡ªã®ãƒ‰ã‚ュメンテーション・コメントをæŒã¤ã“ã¨ãŒã§ãã€ãれを専用ã®ã€Œã‚½ãƒ¼ã‚¹ã€ãƒ•ã‚¡ã‚¤ãƒ«ã«ä¿æŒã—ã¾ã™ã€‚ãã®å†…容ã¯ã€Javadocツールã«ã‚ˆã£ã¦ç”Ÿæˆã•ã‚Œã‚‹ãƒ‘ッケージã®æ¦‚è¦ãƒšãƒ¼ã‚¸ã«çµ„ã¿è¾¼ã¾ã‚Œã¾ã™ã€‚ã“ã®ã‚³ãƒ¡ãƒ³ãƒˆã«ã¯ã€é€šå¸¸ã€ãã®ãƒ‘ッケージ全体ã«å½“ã¦ã¯ã¾ã‚‹ãƒ‰ã‚ュメントを記述ã—ã¾ã™ã€‚ .LP パッケージ・コメント・ファイルを作æˆã™ã‚‹å ´åˆã€ã‚³ãƒ¡ãƒ³ãƒˆã®æ ¼ç´å…ˆã¨ã—ã¦ã€æ¬¡ã®2ã¤ã®ãƒ•ã‚¡ã‚¤ãƒ«ã®ã„ãšã‚Œã‹ã‚’é¸æŠžã§ãã¾ã™ã€‚ .RS 3 .TP 2 o \f2package\-info.java\fP \- パッケージ宣言ã€ãƒ‘ッケージ注釈ã€ãƒ‘ッケージ・コメントã€ãŠã‚ˆã³Javadocã‚¿ã‚°ã‚’æ ¼ç´ã§ãã¾ã™ã€‚ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¯ä¸€èˆ¬ã«ã€package.htmlよりも推奨ã•ã‚Œã¾ã™ã€‚ .TP 2 o \f2package.html\fP \- æ ¼ç´ã§ãã‚‹ã®ã¯ãƒ‘ッケージ・コメントã¨Javadocã‚¿ã‚°ã®ã¿ã§ã™ã€‚パッケージ注釈ã¯æ ¼ç´ã§ãã¾ã›ã‚“。 .RE .LP å„パッケージã¯ã€\f2package.html\fPファイルã¾ãŸã¯\f2package\-info.java\fPファイルã®ã„ãšã‚Œã‹ã‚’1ã¤æŒã¤ã“ã¨ãŒã§ãã¾ã™ãŒã€ãã®ä¸¡æ–¹ã‚’æŒã¤ã“ã¨ã¯ã§ãã¾ã›ã‚“。ã“ã®ã©ã¡ã‚‰ã‹ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’\f2.java\fPファイルã¨ã¨ã‚‚ã«ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リー内ã®ãã®ãƒ‘ッケージ・ディレクトリ内ã«é…ç½®ã—ã¦ãã ã•ã„。 .LP \f4package\-info.java\fP \- ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã«ã¯ã€æ¬¡ã®æ§‹é€ ã®ãƒ‘ãƒƒã‚±ãƒ¼ã‚¸ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã‚’æ ¼ç´ã§ãã¾ã™ã€‚コメントã¯ãƒ‘ッケージ宣言ã®å‰ã«é…ç½®ã—ã¾ã™ã€‚ .LP ファイル: \f2java/applet/package\-info.java\fP .nf \f3 .fl /** .fl * Provides the classes necessary to create an .fl * applet and the classes an applet uses .fl * to communicate with its applet context. .fl * <p> .fl * The applet framework involves two entities: .fl * the applet and the applet context. .fl * An applet is an embeddable window (see the .fl * {@link java.awt.Panel} class) with a few extra .fl * methods that the applet context can use to .fl * initialize, start, and stop the applet. .fl * .fl * @since 1.0 .fl * @see java.awt .fl */ .fl package java.lang.applet; .fl \fP .fi .LP コメント区切り文å—ã®\f2/**\fPã¨\f2*/\fPã¯å˜åœ¨ã—ã¦ã„ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ãŒã€ä¸é–“è¡Œã®è¡Œé ã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã¯çœç•¥ã—ã¦ã‚‚ã‹ã¾ã„ã¾ã›ã‚“。 .LP \f4package.html\fP \- ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã«ã¯ã€æ¬¡ã®æ§‹é€ ã®ãƒ‘ãƒƒã‚±ãƒ¼ã‚¸ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã‚’æ ¼ç´ã§ãã¾ã™ã€‚コメントã¯\f2<body>\fPè¦ç´ 内ã«é…ç½®ã—ã¾ã™ã€‚ .LP ファイル: \f2java/applet/package.html\fP .nf \f3 .fl <HTML> .fl <BODY> .fl Provides the classes necessary to create an applet and the .fl classes an applet uses to communicate with its applet context. .fl <p> .fl The applet framework involves two entities: the applet .fl and the applet context. An applet is an embeddable .fl window (see the {@link java.awt.Panel} class) with a .fl few extra methods that the applet context can use to .fl initialize, start, and stop the applet. .fl .fl @since 1.0 .fl @see java.awt .fl </BODY> .fl </HTML> .fl \fP .fi .LP ã“ã‚Œã¯å˜ãªã‚‹é€šå¸¸ã®HTMLファイルã§ã‚ã‚Šã€ãƒ‘ッケージ宣言をå«ã‚“ã§ã„ãªã„点ã«æ³¨æ„ã—ã¦ãã ã•ã„。パッケージ・コメント・ファイルã®å†…容ã¯ã€ä»–ã®ã™ã¹ã¦ã®ã‚³ãƒ¡ãƒ³ãƒˆã¨åŒæ§˜ã«HTMLã§è¨˜è¿°ã—ã¾ã™ãŒã€ä¾‹å¤–ãŒ1ã¤ã‚ã‚Šã¾ã™ã€‚ãã‚Œã¯ã€ã“ã®ãƒ‰ã‚ュメンテーション・コメントã«ã¯ã€ã‚³ãƒ¡ãƒ³ãƒˆåŒºåˆ‡ã‚Šæ–‡å—ã§ã‚ã‚‹\f2/**\fPã¨\f2*/\fPã€ã¾ãŸã¯è¡Œé ã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã‚’å«ã‚ãªã„ã€ã¨ã„ã†ç‚¹ã§ã™ã€‚コメントを書ãå ´åˆã¯ã€æœ€åˆã®æ–‡ã‚’パッケージã®æ¦‚è¦ã¨ã—ã€\f2<body>\fPã¨æœ€åˆã®æ–‡ã®é–“ã«ã‚¿ã‚¤ãƒˆãƒ«ã‚„ãã®ä»–ã®ãƒ†ã‚ストをå«ã‚ãªã„よã†ã«ã—ã¾ã™ã€‚パッケージ・タグをå«ã‚ã‚‹ã“ã¨ã¯ã§ãã¾ã™ãŒã€ä»–ã®ãƒ‰ã‚ュメンテーション・コメントã¨åŒæ§˜ã€ã™ã¹ã¦ã®ãƒ–ãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ã¯ã€ä¸»èª¬æ˜Žã®å¾Œã«é…ç½®ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\f2@see\fPタグをパッケージ・コメント・ファイルã«è¿½åŠ ã™ã‚‹å ´åˆã«ã¯ã€å®Œå…¨ä¿®é£¾åを使用ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚詳細ã¯ã€ .na \f2package.html\fPã®ä¾‹ @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#packagecommentsã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .LP \f3パッケージ・コメント・ファイルã®å‡¦ç†\fP \- Javadocツールã¯ã€å®Ÿè¡Œæ™‚ã«ãƒ‘ッケージ・コメント・ファイルを自動的ã«æ¤œç´¢ã—ã€ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’見ã¤ã‘ã‚‹ã¨æ¬¡ã®å‡¦ç†ã‚’è¡Œã„ã¾ã™ã€‚ .RS 3 .TP 2 o 処ç†ã§ãるよã†ã«ã‚³ãƒ¡ãƒ³ãƒˆã‚’コピーã—ã¾ã™ã€‚(\f2package.html\fPã®å ´åˆã§ã‚ã‚Œã°ã€\f2<body>\fPã¨\f2</body>\fP HTMLã‚¿ã‚°ã®é–“ã«ã‚る内容をã™ã¹ã¦ã‚³ãƒ”ーã—ã¾ã™ã€‚\f2<head>\fPセクションをå«ã‚ã€ãã“ã«\f2<title>\fPやソース・ファイルã®è‘—作権記述ãªã©ã®æƒ…å ±ã‚’é…ç½®ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ãŒã€ç”Ÿæˆãƒ‰ã‚ュメントã«ã¯ãれらã¯ä¸€åˆ‡è¡¨ç¤ºã•ã‚Œã¾ã›ã‚“。) .TP 2 o パッケージ・タグãŒã‚ã‚Œã°ã€ã™ã¹ã¦å‡¦ç†ã—ã¾ã™ã€‚ .TP 2 o 生æˆã—ãŸãƒ‘ッケージã®æ¦‚è¦ãƒšãƒ¼ã‚¸ã®æœ€å¾Œã«ã€å‡¦ç†ã—ãŸãƒ†ã‚ストを挿入ã—ã¾ã™( .na \f2パッケージã®æ¦‚è¦\fP @ .fi http://docs.oracle.com/javase/7/docs/api/java/applet/package\-summary.htmlã‚’å‚ç…§)。 .TP 2 o パッケージã®æ¦‚è¦ãƒšãƒ¼ã‚¸ã®å…ˆé ã«ã€ãƒ‘ッケージ・コメントã®æœ€åˆã®æ–‡ã‚’コピーã—ã¾ã™ã€‚ã•ã‚‰ã«ã€æ¦‚è¦ãƒšãƒ¼ã‚¸ã®ãƒ‘ッケージ・リストã«ã€ãƒ‘ッケージåã¨ãƒ‘ッケージ・コメントã®æœ€åˆã®æ–‡ã‚’è¿½åŠ ã—ã¾ã™( .na \f2概è¦ã®è¦ç´„\fP @ .fi http://docs.oracle.com/javase/7/docs/api/overview\-summary.htmlã‚’å‚ç…§)。文ã®çµ‚ã‚ã‚Šã¯ã€ã‚¯ãƒ©ã‚¹ã‚„メンãƒãƒ¼ã®ä¸»èª¬æ˜Žã®æœ€åˆã®æ–‡ã®çµ‚ã‚ã‚Šã¨åŒã˜ãƒ«ãƒ¼ãƒ«ã«ã‚ˆã£ã¦åˆ¤æ–ã•ã‚Œã¾ã™ã€‚ .RE .SS 概è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ« .LP ドã‚ュメント化ã™ã‚‹å„アプリケーションã¾ãŸã¯ãƒ‘ッケージ・セットã¯ã€ç‹¬è‡ªã®æ¦‚è¦ãƒ‰ã‚ュメンテーション・コメントをæŒã¤ã“ã¨ãŒã§ãã€ãã‚Œã¯å°‚用ã®ã€Œã‚½ãƒ¼ã‚¹ã€ãƒ•ã‚¡ã‚¤ãƒ«ã«ä¿æŒã•ã‚Œã¾ã™ã€‚ãã®å†…容ã¯ã€Javadocツールã«ã‚ˆã£ã¦ç”Ÿæˆã•ã‚Œã‚‹æ¦‚è¦ãƒšãƒ¼ã‚¸ã«çµ„ã¿è¾¼ã¾ã‚Œã¾ã™ã€‚ã“ã®ã‚³ãƒ¡ãƒ³ãƒˆã«ã¯ã€é€šå¸¸ã€ã‚¢ãƒ—リケーションã¾ãŸã¯ãƒ‘ッケージ・セット全体ã«å½“ã¦ã¯ã¾ã‚‹ãƒ‰ã‚ュメントを記述ã—ã¾ã™ã€‚ .LP 概è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆã™ã‚‹ã«ã¯ã€ãƒ•ã‚¡ã‚¤ãƒ«ã«ä»»æ„ã®åå‰(通常ã¯\f4overview.html\fP)を付ã‘ã€ä»»æ„ã®å ´æ‰€(通常ã¯ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーã®æœ€ä¸Šä½ãƒ¬ãƒ™ãƒ«)ã«é…ç½®ã§ãã¾ã™ã€‚ãŸã¨ãˆã°ã€\f2java.applet\fPパッケージã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒ\f2/home/user/src/java/applet\fPディレクトリã«æ ¼ç´ã•ã‚Œã¦ã„ã‚‹å ´åˆã€æ¦‚è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¯\f2/home/user/src/overview.html\fPã«ä½œæˆã§ãã¾ã™ã€‚ .LP ç•°ãªã‚‹ãƒ‘ッケージã®ã‚»ãƒƒãƒˆã«å¯¾ã—ã¦Javadocを複数回実行ã™ã‚‹å ´åˆã¯ã€åŒã˜1ã¤ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®ã‚»ãƒƒãƒˆã«å¯¾ã—ã¦è¤‡æ•°ã®æ¦‚è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆã§ãã¾ã™ã€‚ãŸã¨ãˆã°ã€å†…部ドã‚ュメント用ã«\-privateを指定ã—ã¦Javadocã‚’1回実行ã—ãŸå¾Œã€å…¬é–‹ãƒ‰ã‚ュメント用ã«ãã®ã‚ªãƒ—ションを指定ã—ãªã„ã§å†åº¦å®Ÿè¡Œã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ã“ã®å ´åˆã€å„概è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®1文目ã§ã€ãã®ãƒ‰ã‚ュメントを公開用ã¾ãŸã¯å†…部用ã¨ã—ã¦è¨˜è¿°ã§ãã¾ã™ã€‚ .LP 概è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®å†…容ã¯ã€å‰è¿°ã®ãƒ‘ッケージ・コメント・ファイルã¨åŒæ§˜ã€HTMLã§è¨˜è¿°ã•ã‚ŒãŸ1ã¤ã®å¤§ããªãƒ‰ã‚ュメンテーション・コメントã§ã™ã€‚詳細ã¯ã€å‰è¿°ã®èª¬æ˜Žã‚’å‚ç…§ã—ã¦ãã ã•ã„。è¦ç‚¹ã‚’ç¹°ã‚Šè¿”ã™ã¨ã€ã‚³ãƒ¡ãƒ³ãƒˆã‚’書ãå ´åˆã¯ã€æœ€åˆã®æ–‡ã‚’アプリケーションã¾ãŸã¯ãƒ‘ッケージ・セットã®æ¦‚è¦ã¨ã—ã€\f2<body>\fPã¨æœ€åˆã®æ–‡ã®é–“ã«ã‚¿ã‚¤ãƒˆãƒ«ã‚„ãã®ä»–ã®ãƒ†ã‚ストをå«ã‚ãªã„よã†ã«ã—ã¾ã™ã€‚概è¦ã‚¿ã‚°ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ä»–ã®ãƒ‰ã‚ュメンテーション・コメントã¨åŒã˜ãã€\f2{@link}\fPãªã©ã®ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ã‚¿ã‚°ã‚’除ãã™ã¹ã¦ã®ã‚¿ã‚°ã¯ã€ä¸»èª¬æ˜Žã®å¾Œã«é…ç½®ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\f2@see\fPã‚¿ã‚°ã‚’è¿½åŠ ã™ã‚‹å ´åˆã«ã¯ã€å®Œå…¨ä¿®é£¾åを使用ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .LP Javadocツールã®å®Ÿè¡Œæ™‚ã«ã€\-overviewオプションを使用ã—ã¦æ¦‚è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åを指定ã—ã¾ã™ã€‚ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€ãƒ‘ッケージ・コメント・ファイルã¨åŒã˜ã‚ˆã†ã«å‡¦ç†ã•ã‚Œã¾ã™ã€‚ .RS 3 .TP 2 o \f2<body>\fPã¨\f2</body>\fPã‚¿ã‚°ã®é–“ã«ã‚る内容をã™ã¹ã¦å‡¦ç†å¯¾è±¡ã¨ã—ã¦ã‚³ãƒ”ーã—ã¾ã™ã€‚ .TP 2 o 概è¦ã‚¿ã‚°ãŒã‚ã‚Œã°ã€ã™ã¹ã¦å‡¦ç†ã—ã¾ã™ã€‚ .TP 2 o 生æˆã—ãŸæ¦‚è¦ãƒšãƒ¼ã‚¸ã®æœ€å¾Œã«ã€å‡¦ç†ã—ãŸãƒ†ã‚ストを挿入ã—ã¾ã™( .na \f2概è¦ã®è¦ç´„\fP @ .fi http://docs.oracle.com/javase/7/docs/api/overview\-summary.htmlã‚’å‚ç…§)。 .TP 2 o 概è¦ãƒšãƒ¼ã‚¸ã®å…ˆé ã«ã€æ¦‚è¦ã‚³ãƒ¡ãƒ³ãƒˆã®æœ€åˆã®æ–‡ã‚’コピーã—ã¾ã™ã€‚ .RE .SS ãã®ä»–ã®æœªå‡¦ç†ã®ãƒ•ã‚¡ã‚¤ãƒ« .LP ソースã«ã¯ã€Javadocツールã«ã‚ˆã£ã¦å®›å…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«ã‚³ãƒ”ーã•ã‚Œã‚‹ã€ãã®ä»–ã®ä»»æ„ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚一般ã«ã€ã“ã®ã‚ˆã†ãªãƒ•ã‚¡ã‚¤ãƒ«ã«ã¯ã€ã‚°ãƒ©ãƒ•ã‚£ãƒƒã‚¯ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã€ã‚µãƒ³ãƒ—ルã®Javaソース(.java)ãŠã‚ˆã³ã‚¯ãƒ©ã‚¹(.class)ファイルã€å†…容ãŒé€šå¸¸ã®Javaソース・ファイルã®ãƒ‰ã‚ュメンテーション・コメントã®å½±éŸ¿ã‚’å—ã‘ãªã„独立ã—ãŸHTMLファイルãªã©ãŒã‚ã‚Šã¾ã™ã€‚ .LP 未処ç†ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’å«ã‚ã‚‹ã«ã¯ã€ãれらã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’\f4doc\-files\fPã¨ã„ã†åå‰ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«ç½®ãã¾ã™ã€‚ã“ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒæ ¼ç´ã•ã‚ŒãŸä»»æ„ã®ãƒ‘ッケージ・ディレクトリã®ã‚µãƒ–ディレクトリã§ã‚‚ã‹ã¾ã„ã¾ã›ã‚“。ã“ã®ã‚ˆã†ãªã‚µãƒ–ディレクトリã¯ã€ãƒ‘ッケージã”ã¨ã«1ã¤ç”¨æ„ã§ãã¾ã™ã€‚イメージã€ã‚µãƒ³ãƒ—ル・コードã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã€.classファイルã€ã‚¢ãƒ—レットã€ãŠã‚ˆã³HTMLファイルをã“ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«æ ¼ç´ã§ãã¾ã™ã€‚ãŸã¨ãˆã°ã€ãƒœã‚¿ãƒ³ã®ã‚¤ãƒ¡ãƒ¼ã‚¸\f2button.gif\fPã‚’\f2java.awt.Button\fPクラスã®ãƒ‰ã‚ュメントã«å«ã‚ã‚‹å ´åˆã«ã¯ã€ãã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’\f2/home/user/src/java/awt/doc\-files/\fPディレクトリã«ç½®ãã¾ã™ã€‚ãªãŠã€\f2doc\-files\fPディレクトリを\f2/home/user/src/java/doc\-files\fPã«ç½®ãã“ã¨ã¯ã§ãã¾ã›ã‚“。ã“ã‚Œã¯ã€\f2java\fPãŒãƒ‘ッケージã§ã¯ãªã„ã‹ã‚‰ã§ã™ã€‚ã¤ã¾ã‚Šã€javaãã®ã‚‚ã®ã«ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒ1ã¤ã‚‚æ ¼ç´ã•ã‚Œã¦ã„ãªã„ã‹ã‚‰ã§ã™ã€‚ .LP ã“れらã®æœªå‡¦ç†ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¸ã®ãƒªãƒ³ã‚¯ã¯ã€ã™ã¹ã¦ãƒãƒ¼ãƒ‰ã‚³ãƒ¼ãƒ‰ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã“ã‚Œã¯ã€JavadocツールãŒãれらã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’見ãšã«ã€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¨ãã®å†…容を宛先ã«ãã®ã¾ã¾ã‚³ãƒ”ーã™ã‚‹ã‹ã‚‰ã§ã™ã€‚ãŸã¨ãˆã°ã€\f2Button.java\fPã®ãƒ‰ã‚ュメンテーション・コメント内ã®ãƒªãƒ³ã‚¯ã¯ã€æ¬¡ã®ã‚ˆã†ã«ãªã‚Šã¾ã™ã€‚ .nf \f3 .fl /** .fl * This button looks like this: .fl * <img src="doc\-files/Button.gif"> .fl */ .fl \fP .fi .SS テスト・ファイルãŠã‚ˆã³ãƒ†ãƒ³ãƒ—レート・ファイル .LP 一部ã®é–‹ç™ºè€…ã‹ã‚‰ã€ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŠã‚ˆã³ãƒ†ãƒ³ãƒ—レート・ファイルを対応ã™ã‚‹ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®è¿‘ãã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーã«ä¿å˜ã—ãŸã„ã¨ã„ã†è¦æœ›ãŒã‚ã‚Šã¾ã—ãŸã€‚ã¤ã¾ã‚Šã€ã“れらã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¨åŒã˜ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¾ãŸã¯ã‚µãƒ–ディレクトリã«ä¿å˜ã—ãŸã„ã¨ã„ã†ã“ã¨ã§ã™ã€‚ .LP 個々ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åã§æ˜Žç¤ºçš„ã«æ¸¡ã—ã¦Javadocツールを実行ã™ã‚‹å ´åˆã€ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŠã‚ˆã³ãƒ†ãƒ³ãƒ—レート・ファイルをæ„図的ã«é™¤å¤–ã—ã¦ã€å‡¦ç†ã•ã‚Œãªã„よã†ã«ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ãŸã ã—ã€ãƒ‘ッケージåã¾ãŸã¯ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰ã§æ¸¡ã™å ´åˆã¯ã€ç‰¹å®šã®ãƒ«ãƒ¼ãƒ«ã«å¾“ã£ã¦ã€ã“れらã®ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŠã‚ˆã³ãƒ†ãƒ³ãƒ—レート・ファイルãŒå‡¦ç†ã•ã‚Œãªã„よã†ã«ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .LP テスト・ファイルã¨ãƒ†ãƒ³ãƒ—レート・ファイルã®é•ã„ã¯ã€ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€æœ‰åŠ¹ã§ã‚³ãƒ³ãƒ‘イルå¯èƒ½ãªã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã§ã‚ã‚‹ã®ã«å¯¾ã—ã¦ã€ãƒ†ãƒ³ãƒ—レート・ファイルã¯ã€ãã†ã§ã¯ãªã„ã¨ã„ã†ç‚¹ã§ã™ã€‚ãŸã ã—ã€ãƒ†ãƒ³ãƒ—レート・ファイルも「.javaã€ã§çµ‚ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ .LP \f3テスト・ファイル\fP \- 開発者ã®å¤šãã¯ã€ã‚るパッケージã®ã‚³ãƒ³ãƒ‘イルå¯èƒ½ã§å®Ÿè¡Œå¯èƒ½ãªãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’ãã®ãƒ‘ッケージã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¨\f2åŒã˜\fPディレクトリã«é…ç½®ã—ãŸã„ã¨è€ƒãˆã¦ã„ã¾ã™ã€‚ã—ã‹ã—テスト・ファイルã¯ã€åå‰ãªã—パッケージãªã©ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãƒ»ãƒ‘ッケージã¨ã¯åˆ¥ã®ãƒ‘ッケージã«å±žã•ã›ãŸã„ã¨ã‚‚考ãˆã¦ã„ã¾ã™(ãã®ãŸã‚ã€ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã«ã¯packageæ–‡ãŒãªã„ã‹ã€ã¾ãŸã¯ã‚½ãƒ¼ã‚¹ã¨ã¯åˆ¥ã®packageæ–‡ãŒã‚ã‚Šã¾ã™)。ã“ã®ã‚ˆã†ãªçŠ¶æ³ã§ã¯ã€ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã§æŒ‡å®šã•ã‚Œã¦ã„るソースã®ãƒ‘ッケージåを指定ã—ã¦ãã®ã‚½ãƒ¼ã‚¹ãŒãƒ‰ã‚ュメント化ã•ã‚Œã¦ã„ã‚‹ã¨ãã«ã€ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¯è¦å‘Šã¾ãŸã¯ã‚¨ãƒ©ãƒ¼ã‚’引ãèµ·ã“ã—ã¾ã™ã€‚ãã®ã‚ˆã†ãªãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã‚µãƒ–ディレクトリã«é…ç½®ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ãŸã¨ãˆã°ã€\f2com.package1\fP内ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã«å¯¾ã™ã‚‹ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’è¿½åŠ ã™ã‚‹å ´åˆã¯ã€æ¬¡ã®ã‚ˆã†ã«ãƒã‚¤ãƒ•ãƒ³ã‚’å«ã‚“ã§ã„ã‚‹ãŸã‚ã«ãƒ‘ッケージåã¨ã—ã¦ã¯ç„¡åŠ¹ãªåå‰ã®ã‚µãƒ–ディレクトリ内ã«é…ç½®ã—ã¾ã™ã€‚ .nf \f3 .fl com/package1/test\-files/ .fl \fP .fi .LP ã“ã‚Œã§ã€Javadocツールã¯è¦å‘Šãªã—ã§testディレクトリをスã‚ップã—ã¾ã™ã€‚ .LP テスト・ファイルã«ãƒ‰ã‚ュメンテーション・コメントãŒå«ã¾ã‚Œã‚‹å ´åˆã€Javadocツールã®å€‹åˆ¥ã®å®Ÿè¡Œã§ã€ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰ã‚’å«ã‚“ã テスト・ソース・ファイルå(\f2com/package1/test\-files/*.java\fPãªã©)ã§æ¸¡ã—ã¦ãƒ†ã‚¹ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®ãƒ‰ã‚ュメントを生æˆã™ã‚‹ã‚ˆã†ã«è¨å®šã§ãã¾ã™ã€‚ .LP \f3ソース・ファイルã®ãƒ†ãƒ³ãƒ—レート\fP \- テンプレート・ファイルã®åå‰ã¯ã€Œ.javaã€ã§çµ‚ã‚ã‚‹ã“ã¨ã‚‚ã‚ã‚Šã¾ã™ãŒã€ãƒ†ãƒ³ãƒ—レート・ファイルã¯ã‚³ãƒ³ãƒ‘イルã§ãã¾ã›ã‚“。ソース・ディレクトリ内ã«ä¿æŒã—ãŸã„ソース・ファイルã®ãƒ†ãƒ³ãƒ—レートãŒã‚ã‚‹å ´åˆã¯ã€\f2Buffer\-Template.java\fPã®ã‚ˆã†ã«ãƒã‚¤ãƒ•ãƒ³ã‚„ãã®ä»–ã®ç„¡åŠ¹ãªJavaæ–‡å—ã‚’åå‰ã«å«ã‚ã‚‹ã“ã¨ã§ã€ãƒ†ãƒ³ãƒ—レートãŒå‡¦ç†ã•ã‚Œãªã„よã†ã«ã—ã¾ã™ã€‚ã“ã‚Œã¯ã€JavadocツールãŒå‡¦ç†ã™ã‚‹ã®ã¯ã€ã€Œ.javaã€æŽ¥å°¾è¾žã‚’除ã„ãŸåå‰ãŒæœ‰åŠ¹ãªã‚¯ãƒ©ã‚¹åã§ã‚るソース・ファイルã®ã¿ã§ã‚ã‚‹ãŸã‚ã§ã™(Java言語仕様ã®è˜åˆ¥åã«é–¢ã™ã‚‹æƒ…å ±ã‚’å‚ç…§)。 .SH "生æˆã•ã‚Œã‚‹ãƒ•ã‚¡ã‚¤ãƒ«" .LP デフォルトã§ã¯ã€Javadocã¯ã€HTMLå½¢å¼ã®ãƒ‰ã‚ュメントを生æˆã™ã‚‹æ¨™æº–ドックレットを使用ã—ã¾ã™ã€‚ã“ã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã¯ã€æ¬¡ã®ã‚¿ã‚¤ãƒ—ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’生æˆã—ã¾ã™ã€‚(ãã‚Œãžã‚Œã®HTMLページã¯ã€åˆ¥å€‹ã®ãƒ•ã‚¡ã‚¤ãƒ«ã«ç›¸å½“ã—ã¾ã™ã€‚)JavadocãŒç”Ÿæˆã™ã‚‹ãƒ•ã‚¡ã‚¤ãƒ«ã®åå‰ã«ã¯ã€ã‚¯ãƒ©ã‚¹ã‚„インタフェースã®åå‰ã«ã¡ãªã‚“ã ã‚‚ã®ã¨ã€ãã†ã§ãªã„ã‚‚ã®(\f2package\-summary.htmlãªã©\fP)ã®2ã¤ã®ã‚¿ã‚¤ãƒ—ãŒã‚ã‚Šã¾ã™ã€‚後者ã®ã‚°ãƒ«ãƒ¼ãƒ—ã®ãƒ•ã‚¡ã‚¤ãƒ«åã«ã¯ã€å‰è€…ã®ã‚°ãƒ«ãƒ¼ãƒ—ã¨ãƒ•ã‚¡ã‚¤ãƒ«åãŒç«¶åˆã—ãªã„よã†ã«ã€ãƒã‚¤ãƒ•ãƒ³ãŒå«ã¾ã‚Œã¦ã„ã¾ã™ã€‚ .LP \f3基本内容ページ\fP .RS 3 .TP 2 o ドã‚ュメント化ã™ã‚‹ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã”ã¨ã«1ã¤ã®\f3クラス・ページã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ãƒ»ãƒšãƒ¼ã‚¸\fP(\f2クラスå\fP\f2.html\fP) .TP 2 o ドã‚ュメント化ã™ã‚‹ãƒ‘ッケージã”ã¨ã«1ã¤ã®\f3パッケージ・ページ\fP(\f2package\-summary.html\fP)。Javadocツールã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーã®ãƒ‘ッケージ・ディレクトリ内ã«ã‚ã‚‹\f2package.html\fPã¾ãŸã¯\f2package\-info.java\fPã¨ã„ã†åå‰ã®ãƒ•ã‚¡ã‚¤ãƒ«å†…ã®HTMLテã‚ストをã™ã¹ã¦çµ„ã¿å…¥ã‚Œã¾ã™ã€‚ .TP 2 o パッケージã®ã‚»ãƒƒãƒˆå…¨ä½“ã«å¯¾ã—ã¦1ã¤ã®\f3概è¦ãƒšãƒ¼ã‚¸\fP(\f2overview\-summary.html\fP)。ã“ã‚Œã¯ã€ç”Ÿæˆãƒ‰ã‚ュメントã®å…ˆé ページã«ãªã‚Šã¾ã™ã€‚Javadocツールã¯ã€\f2\-overview\fPオプションã§æŒ‡å®šã•ã‚ŒãŸãƒ•ã‚¡ã‚¤ãƒ«å†…ã®HTMLテã‚ストをã™ã¹ã¦çµ„ã¿å…¥ã‚Œã¾ã™ã€‚ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€Javadocã«è¤‡æ•°ã®ãƒ‘ッケージåを渡ã—ãŸå ´åˆã«ã®ã¿ä½œæˆã•ã‚Œã¾ã™ã€‚詳細ã¯ã€HTMLフレームをå‚ç…§ã—ã¦ãã ã•ã„。 .RE .LP \f3相互å‚照ページ\fP .RS 3 .TP 2 o \f3パッケージã®ã‚»ãƒƒãƒˆå…¨ä½“ã«å¯¾ã—ã¦1ã¤ã®ã‚¯ãƒ©ã‚¹éšŽå±¤ãƒšãƒ¼ã‚¸\fP(\f2overview\-tree.html\fP)。ã“ã®ãƒšãƒ¼ã‚¸ã‚’表示ã™ã‚‹ã«ã¯ã€ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®ã€Œæ¦‚è¦ã€ã‚’クリックã—ã¦ã‹ã‚‰ã€ã€ŒéšŽå±¤ãƒ„リーã€ã‚’クリックã—ã¾ã™ã€‚ .TP 2 o \f3パッケージã”ã¨ã«1ã¤ã®ã‚¯ãƒ©ã‚¹éšŽå±¤ãƒšãƒ¼ã‚¸\fP(\f2package\-tree.html\fP)。ã“ã®ãƒšãƒ¼ã‚¸ã‚’表示ã™ã‚‹ã«ã¯ã€ç‰¹å®šã®ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ãƒšãƒ¼ã‚¸ã«ç§»å‹•ã—ã€ã€ŒéšŽå±¤ãƒ„リーã€ã‚’クリックã—ã¦ãã®ãƒ‘ッケージã®éšŽå±¤ã‚’表示ã—ã¾ã™ã€‚ .TP 2 o \f3パッケージã”ã¨ã«1ã¤ã®ã€Œä½¿ç”¨ã€ãƒšãƒ¼ã‚¸\fP(\f2package\-use.html\fP)ã¨ã€ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã”ã¨ã«1ã¤ãšã¤ã®ã€Œä½¿ç”¨ã€ãƒšãƒ¼ã‚¸(\f2class\-use/\fP\f2クラスå\fP\f2.html\fP)。ã“ã®ãƒšãƒ¼ã‚¸ã«ã¯ã€ç‰¹å®šã®ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã¾ãŸã¯ãƒ‘ッケージã®ä¸€éƒ¨ã‚’使用ã—ã¦ã„るパッケージã€ã‚¯ãƒ©ã‚¹ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãŠã‚ˆã³ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã«ã¤ã„ã¦è¨˜è¿°ã•ã‚Œã¾ã™ã€‚クラスã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹Aを例ã«ã—ã¦è€ƒãˆã‚‹ã¨ã€ãã®ã€Œä½¿ç”¨ã€ãƒšãƒ¼ã‚¸ã«ã¯ã€Aã®ã‚µãƒ–クラスã€Aã¨ã—ã¦å®£è¨€ã•ã‚ŒãŸãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã€Aã‚’è¿”ã™ãƒ¡ã‚½ãƒƒãƒ‰ã€Aåž‹ã®ãƒ‘ラメータをæŒã¤ãƒ¡ã‚½ãƒƒãƒ‰ãŠã‚ˆã³ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ãŒçµ„ã¿è¾¼ã¾ã‚Œã¾ã™ã€‚ã“ã®ãƒšãƒ¼ã‚¸ã‚’表示ã™ã‚‹ã«ã¯ã€ã¾ãšã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã«ç§»å‹•ã—ã¦ã‹ã‚‰ã€ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®ã€Œä½¿ç”¨ã€ãƒªãƒ³ã‚¯ã‚’クリックã—ã¾ã™ã€‚ .TP 2 o \f3éžæŽ¨å¥¨APIページ\fP(\f2deprecated\-list.html\fP)。推奨ã•ã‚Œãªã„åå‰ãŒã™ã¹ã¦ãƒªã‚¹ãƒˆã•ã‚Œã¾ã™ã€‚(éžæŽ¨å¥¨åã¯ã€ä¸€èˆ¬ã«æ”¹è‰¯ã•ã‚ŒãŸãŸã‚ã«ä½¿ç”¨ãŒæŽ¨å¥¨ã•ã‚Œã¦ã„ãªã„APIã®åå‰ã§ã‚ã‚Šã€é€šå¸¸ã€ãã‚Œã«ç½®ãæ›ã‚ã‚‹åå‰ãŒæ示ã•ã‚Œã¦ã„ã¾ã™ã€‚éžæŽ¨å¥¨APIã¯ã€å°†æ¥ã®å®Ÿè£…ã§ã¯å‰Šé™¤ã•ã‚Œã‚‹å¯èƒ½æ€§ãŒã‚ã‚Šã¾ã™ã€‚) .TP 2 o \f3定数フィールド値ページ\fP(\f2constant\-values.html\fP)。staticフィールドã®å€¤ç”¨ã§ã™ã€‚ .TP 2 o \f3直列化ã•ã‚ŒãŸå½¢å¼ãƒšãƒ¼ã‚¸\fP(\f2serialized\-form.html\fP)。直列化å¯èƒ½ã‹ã¤å¤–部化å¯èƒ½ãªã‚¯ãƒ©ã‚¹ã«é–¢ã™ã‚‹æƒ…å ±ç”¨ã®ãƒšãƒ¼ã‚¸ã§ã™ã€‚ã“れらã®å„クラスã«ã¯ã€ç›´åˆ—化フィールドãŠã‚ˆã³ãƒ¡ã‚½ãƒƒãƒ‰ã«é–¢ã™ã‚‹è¨˜è¿°ãŒã‚ã‚Šã¾ã™ã€‚ã“れらã®æƒ…å ±ã¯ã€APIを使用ã™ã‚‹é–‹ç™ºè€…ã§ã¯ãªãã€å†å®Ÿè£…者ã«å¿…è¦ãªæƒ…å ±ã§ã™ã€‚ナビゲーション・ãƒãƒ¼ã«ã“ã®ãƒšãƒ¼ã‚¸ã¸ã®ãƒªãƒ³ã‚¯ã¯ã‚ã‚Šã¾ã›ã‚“ãŒã€ç›´åˆ—化ã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã«ç§»å‹•ã—ã¦ã€ãã®ã‚¯ãƒ©ã‚¹ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã«ã‚ã‚‹ã€Œé–¢é€£é …ç›®ã€ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã§ã€Œç›´åˆ—化ã•ã‚ŒãŸå½¢å¼ã€ã‚’クリックã™ã‚‹ã¨ã€ã“ã®æƒ…å ±ã‚’å–å¾—ã§ãã¾ã™ã€‚標準ドックレットã¯ç›´åˆ—化ã•ã‚ŒãŸå½¢å¼ãƒšãƒ¼ã‚¸ã‚’自動生æˆã—ã¾ã™ã€‚ã“ã®ãƒšãƒ¼ã‚¸ã«ã¯ã€Serializableを実装ã™ã‚‹ã™ã¹ã¦ã®ã‚¯ãƒ©ã‚¹(publicã¾ãŸã¯éžpublic)ãŒçµ„ã¿è¾¼ã¾ã‚Œã‚‹ä»–ã€\f2readObject\fPメソッドや\f2writeObject\fPメソッドã€ç›´åˆ—化ã•ã‚ŒãŸãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã€ãŠã‚ˆã³\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オプションã®æŒ‡å®š\f2ãªã—\fPã§Javadocツールを実行ã™ã‚‹ã“ã¨ã«ã‚ˆã‚Šã€publicクラスãŠã‚ˆã³privateクラスã®å®Œå…¨ã«ç›´åˆ—化ã•ã‚ŒãŸå½¢å¼ã‚’生æˆã§ãã¾ã™ã€‚ .TP 2 o \f3索引\fP(\f2index\-*.html\fP)。ã™ã¹ã¦ã®ã‚¯ãƒ©ã‚¹åã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹åã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿åã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰åã€ãŠã‚ˆã³ãƒ¡ã‚½ãƒƒãƒ‰åãŒã‚¢ãƒ«ãƒ•ã‚¡ãƒ™ãƒƒãƒˆé †ã«ä¸¦ã‚“ã§ã„ã¾ã™ã€‚索引ã¯ã€Unicodeを扱ãˆã‚‹ã‚ˆã†ã«å›½éš›åŒ–ã•ã‚Œã¦ã„ã¾ã™ã€‚1ã¤ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¨ã—ã¦ç”Ÿæˆã™ã‚‹ã“ã¨ã‚‚ã€å…ˆé æ–‡å—(英語ã®å ´åˆA\-Z)ã”ã¨ã«åˆ¥ã€…ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¨ã—ã¦ç”Ÿæˆã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚ .RE .LP \f3サãƒãƒ¼ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«\fP .RS 3 .TP 2 o \f3ヘルプ・ページ\fP(\f2help\-doc.html\fP)。ナビゲーション・ãƒãƒ¼ã‚„å‰è¿°ã®å„ページã«é–¢ã™ã‚‹èª¬æ˜ŽãŒè¨˜è¼‰ã•ã‚Œã¦ã„ã¾ã™ã€‚\f2\-helpfile\fPを使用ã™ã‚‹ã¨ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®ãƒ˜ãƒ«ãƒ—・ファイルã«ä»£ã‚る独自ã®ã‚«ã‚¹ã‚¿ãƒ ・ヘルプ・ファイルをæä¾›ã§ãã¾ã™ã€‚ .TP 2 o 表示用ã®HTMLフレームを作æˆã™ã‚‹1ã¤ã®\f3index.htmlファイル\fP。ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€ãƒ•ãƒ¬ãƒ¼ãƒ 付ãã®å…ˆé ページを表示ã™ã‚‹å ´åˆã«ãƒãƒ¼ãƒ‰ã—ã¾ã™ã€‚ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«è‡ªä½“ã«ã¯ã€ãƒ†ã‚スト・コンテンツã¯å«ã¾ã‚Œã¦ã„ã¾ã›ã‚“。 .TP 2 o 複数ã®\f3フレーム・ファイル\fP(\f2*\-frame.html\fP)。パッケージã€ã‚¯ãƒ©ã‚¹ã€ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ãƒªã‚¹ãƒˆãŒå«ã¾ã‚Œã¦ã„ã¾ã™ã€‚HTMLフレームを表示ã™ã‚‹ã¨ãã«ä½¿ç”¨ã•ã‚Œã¾ã™ã€‚ .TP 2 o \f3パッケージ・リスト\fPファイル(\f2package\-list\fP)。\f2\-link\fPãŠã‚ˆã³\f2\-linkoffline\fPオプションã§ä½¿ç”¨ã•ã‚Œã¾ã™ã€‚ã“ã‚Œã¯ã€HTMLファイルã§ã¯ãªãテã‚スト・ファイルã§ã‚ã‚Šã€ã©ã®ãƒªãƒ³ã‚¯ã‹ã‚‰ã‚‚アクセスã§ãã¾ã›ã‚“。 .TP 2 o \f3スタイルシート\fP・ファイル(\f2stylesheet.css\fP)。生æˆã•ã‚Œã‚‹ãƒšãƒ¼ã‚¸ã®ä¸€éƒ¨ã®è¦ç´ ã«ã¤ã„ã¦è‰²ã€ãƒ•ã‚©ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ãƒŸãƒªã€ãƒ•ã‚©ãƒ³ãƒˆãƒ»ã‚µã‚¤ã‚ºã€ãƒ•ã‚©ãƒ³ãƒˆãƒ»ã‚¹ã‚¿ã‚¤ãƒ«ã€ãŠã‚ˆã³é…置を制御ã—ã¾ã™ã€‚ .TP 2 o \f3doc\-files\fPディレクトリ。宛先ディレクトリã«ã‚³ãƒ”ーã™ã‚‹ã‚¤ãƒ¡ãƒ¼ã‚¸ã€ã‚µãƒ³ãƒ—ル・コードã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ãªã©ã®ãƒ•ã‚¡ã‚¤ãƒ«ãŒã™ã¹ã¦æ ¼ç´ã•ã‚Œã¾ã™ã€‚ã“れらã®ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€ã„ã‹ãªã‚‹æ–¹æ³•ã§ã‚‚Javadocツールã«ã‚ˆã£ã¦å‡¦ç†ã•ã‚Œã¾ã›ã‚“。ã¤ã¾ã‚Šã€ãƒ•ã‚¡ã‚¤ãƒ«å†…ã«javadocã‚¿ã‚°ãŒã‚ã£ã¦ã‚‚無視ã•ã‚Œã¾ã™ã€‚ã“ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーã®ä¸ã«å˜åœ¨ã™ã‚‹å ´åˆã«ã®ã¿ç”Ÿæˆã•ã‚Œã¾ã™ã€‚ .RE .LP \f3HTMLフレーム\fP .LP Javadocツールã¯ã€ä¸‹ã®å›³ã«ç¤ºã™ã‚ˆã†ã«ã€2ã€3個ã®HTMLフレームを生æˆã—ã¾ã™ã€‚1ã¤ã®ãƒ‘ッケージã—ã‹ãªã„å ´åˆ(ã¾ãŸã¯ãƒ‘ッケージãŒãªã„å ´åˆ)ã¯ã€ãƒ‘ッケージã®ãƒªã‚¹ãƒˆã‚’çœç•¥ã™ã‚‹ã“ã¨ã«ã‚ˆã£ã¦æœ€ä½Žé™å¿…è¦ãªæ•°ã®ãƒ•ãƒ¬ãƒ¼ãƒ を作æˆã—ã¾ã™ã€‚ã¤ã¾ã‚Šã€å˜ä¸€ã®ãƒ‘ッケージã«å±žã™ã‚‹ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«(*.java)ã¾ãŸã¯å˜ä¸€ã®ãƒ‘ッケージåを引数ã¨ã—ã¦javadocコマンドã«æ¸¡ã™å ´åˆã¯ã€å·¦å´ã®åˆ—ã«ã‚¯ãƒ©ã‚¹ã®ãƒªã‚¹ãƒˆã‚’表示ã™ã‚‹ãƒ•ãƒ¬ãƒ¼ãƒ (C)ãŒ1ã¤ã®ã¿ä½œæˆã•ã‚Œã¾ã™ã€‚Javadocã«è¤‡æ•°ã®ãƒ‘ッケージåを渡ã—ãŸå ´åˆã¯ã€æ¦‚è¦ãƒšãƒ¼ã‚¸(Detail)ã«åŠ ãˆã¦ã€ã™ã¹ã¦ã®ãƒ‘ッケージをリストã™ã‚‹ç¬¬3ã®ãƒ•ãƒ¬ãƒ¼ãƒ (P)ãŒä½œæˆã•ã‚Œã¾ã™ã€‚ã“ã®æ¦‚è¦ãƒšãƒ¼ã‚¸ã®ãƒ•ã‚¡ã‚¤ãƒ«åã¯ã€\f2overview\-summary.html\fPã§ã™ã€‚ã—ãŸãŒã£ã¦ã€ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€è¤‡æ•°ã®ãƒ‘ッケージåを渡ã—ãŸå ´åˆã«ã®ã¿ä½œæˆã•ã‚Œã¾ã™ã€‚「フレームãªã—ã€ãƒªãƒ³ã‚¯ã‚’クリックã™ã‚‹ã‹ã€overview\-summary.htmlを最åˆã«è¡¨ç¤ºã™ã‚‹ã¨ã€ãƒ•ãƒ¬ãƒ¼ãƒ ã‚’çœç•¥ã§ãã¾ã™ã€‚ .LP HTMLフレームã«æ…£ã‚Œã¦ã„ãªã„å ´åˆã¯ã€ç‰¹å®šã®ãƒ•ãƒ¬ãƒ¼ãƒ ã‚’å°åˆ·ãŠã‚ˆã³ã‚¹ã‚¯ãƒãƒ¼ãƒ«ã™ã‚‹ã«ã¯ã€ãã®ãƒ•ãƒ¬ãƒ¼ãƒ ã«\f2フォーカス\fPãŒå¿…è¦ã§ã‚ã‚‹ã“ã¨ã«æ³¨æ„ã—ã¦ãã ã•ã„。フレームã«ãƒ•ã‚©ãƒ¼ã‚«ã‚¹ã‚’与ãˆã‚‹ã«ã¯ã€ãã®ãƒ•ãƒ¬ãƒ¼ãƒ をクリックã—ã¾ã™ã€‚ã“ã‚Œã§ã€å¤šãã®ãƒ–ラウザã§ã¯ã€çŸ¢å°ã‚ーやページ・ã‚ーを使用ã—ã¦ãã®ãƒ•ãƒ¬ãƒ¼ãƒ をスクãƒãƒ¼ãƒ«ã—ãŸã‚Šã€ã€Œå°åˆ·ã€ãƒ¡ãƒ‹ãƒ¥ãƒ¼ãƒ»ã‚³ãƒžãƒ³ãƒ‰ã‚’使用ã—ã¦ãã®ãƒ•ãƒ¬ãƒ¼ãƒ ã‚’å°åˆ·ã—ãŸã‚Šã§ãã¾ã™ã€‚ .LP HTMLフレームãŒå¿…è¦ã‹ã©ã†ã‹ã«ã‚ˆã£ã¦ã€æ¬¡ã®ã„ãšã‚Œã‹ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’開始ページã¨ã—ã¦ãƒãƒ¼ãƒ‰ã—ã¾ã™ã€‚ .RS 3 .TP 2 o \f2index.html\fP(フレームã‚ã‚Š) .TP 2 o \f2overview\-summary.html\fP(フレームãªã—) .RE .LP \f3生æˆã•ã‚Œã‚‹ãƒ•ã‚¡ã‚¤ãƒ«ã®æ§‹é€ \fP .LP 生æˆã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€Javaソース・ファイルãŠã‚ˆã³ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¨åŒã˜ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªéšŽå±¤ã«ç·¨æˆã•ã‚Œã¾ã™ã€‚1ã¤ã®ã‚µãƒ–パッケージã«ã¤ã1ã¤ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã€ã¨ã„ã†æ§‹é€ ã«ãªã‚Šã¾ã™ã€‚ .LP ãŸã¨ãˆã°ã€\f2java.applet.Applet\fPクラス用ã«ç”Ÿæˆã•ã‚Œã‚‹ãƒ‰ã‚ュメントã¯ã€\f2java/applet/Applet.html\fPã«æ ¼ç´ã•ã‚Œã¾ã™ã€‚生æˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã®åå‰ãŒ\f2apidocs\fPã ã¨ã™ã‚‹ã¨ã€java.appletパッケージã®ãƒ•ã‚¡ã‚¤ãƒ«ã®æ§‹é€ ã¯ã€æ¬¡ã®ã¨ãŠã‚Šã§ã™ã€‚å‰è¿°ã®ã‚ˆã†ã«ã€ã€Œframeã€ã¨ã„ã†èªžã‚’åå‰ã«å«ã‚€ãƒ•ã‚¡ã‚¤ãƒ«ã¯ã€ã™ã¹ã¦å·¦ä¸Šã¾ãŸã¯å·¦ä¸‹ã®ãƒ•ãƒ¬ãƒ¼ãƒ ã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ãれ以外ã®HTMLファイルã¯ã€ã™ã¹ã¦å³å´ã®ãƒ•ãƒ¬ãƒ¼ãƒ ã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .LP æ³¨æ„ \- ディレクトリã¯\f3太å—\fPã§ç¤ºã—ã¦ã„ã¾ã™ã€‚アスタリスク(\f2*\fP)ã¯ã€Javadocã¸ã®å¼•æ•°ãŒãƒ‘ッケージåã§ã¯ãªãソース・ファイルå(*.java)ã§ã‚ã‚‹å ´åˆã«\f2çœç•¥ã•ã‚Œã‚‹\fPファイルãŠã‚ˆã³ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’示ã—ã¦ã„ã¾ã™ã€‚ã¾ãŸã€å¼•æ•°ãŒã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åã®å ´åˆã€\f2package\-list\fPã¯ä½œæˆã•ã‚Œã¾ã™ãŒã€ãã®ä¸èº«ã¯ç©ºã§ã™ã€‚doc\-filesディレクトリã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リー内ã«å˜åœ¨ã™ã‚‹å ´åˆã«ã®ã¿ã€ç”Ÿæˆå…ˆã«ä½œæˆã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl .fl \fP\f3apidocs\fP Top directory .fl index.html Initial page that sets up HTML frames .fl * overview\-summary.html Lists all packages with first sentence summaries .fl overview\-tree.html Lists class hierarchy for all packages .fl deprecated\-list.html Lists deprecated API for all packages .fl constant\-values.html Lists values of static fields for all packages .fl serialized\-form.html Lists serialized form for all packages .fl * overview\-frame.html Lists all packages, used in upper\-left frame .fl allclasses\-frame.html Lists all classes for all packages, used in lower\-left frame .fl help\-doc.html Lists user help for how these pages are organized .fl index\-all.html Default index created without \-splitindex option .fl \f3index\-files\fP Directory created with \-splitindex option .fl index\-<number>.html Index files created with \-splitindex option .fl package\-list Lists package names, used only for resolving external refs .fl stylesheet.css HTML style sheet for defining fonts, colors and positions .fl \f3java\fP Package directory .fl \f3applet\fP Subpackage directory .fl Applet.html Page for Applet class .fl AppletContext.html Page for AppletContext interface .fl AppletStub.html Page for AppletStub interface .fl AudioClip.html Page for AudioClip interface .fl * package\-summary.html Lists classes with first sentence summaries for this package .fl * package\-frame.html Lists classes in this package, used in lower left\-hand frame .fl * package\-tree.html Lists class hierarchy for this package .fl package\-use Lists where this package is used .fl \f3doc\-files\fP Directory holding image and example files .fl \f3class\-use\fP Directory holding pages API is used .fl Applet.html Page for uses of Applet class .fl AppletContext.html Page for uses of AppletContext interface .fl AppletStub.html Page for uses of AppletStub interface .fl AudioClip.html Page for uses of AudioClip interface .fl \f3src\-html\fP Source code directory .fl \f3java\fP Package directory .fl \f3applet\fP Subpackage directory .fl Applet.html Page for Applet source code .fl AppletContext.html Page for AppletContext source code .fl AppletStub.html Page for AppletStub source code .fl AudioClip.html Page for AudioClip source code .fl .fi .SS 生æˆã•ã‚Œã‚‹API宣言 .LP Javadocツールã¯ã€ãã‚Œãžã‚Œã®ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãŠã‚ˆã³ãƒ¡ã‚½ãƒƒãƒ‰ã®è¨˜è¿°ã®æœ€åˆã«ã€ãã®API用ã®å®£è¨€ã‚’生æˆã—ã¾ã™ã€‚ãŸã¨ãˆã°ã€\f2Boolean\fPクラスã®å®£è¨€ã¯ã€æ¬¡ã®ã‚ˆã†ã«ãªã‚Šã¾ã™ã€‚ .LP \f2public final class Boolean\fP .br \f2extends Object\fP .br \f2implements Serializable\fP .LP ã¾ãŸã€\f2Boolean.valueOf\fPメソッドã®å®£è¨€ã¯ã€æ¬¡ã®ã‚ˆã†ã«ãªã‚Šã¾ã™ã€‚ .LP \f2public static Boolean valueOf(String s)\fP .LP Javadocツールã§ã¯ã€ä¿®é£¾å\f2public\fPã€\f2protected\fPã€\f2private\fPã€\f2abstract\fPã€\f2final\fPã€\f2static\fPã€\f2transient\fPã€ãŠã‚ˆã³\f2volatile\fPを組ã¿è¾¼ã‚€ã“ã¨ã¯ã§ãã¾ã™ãŒã€\f2synchronized\fPã¨\f2native\fPを組ã¿è¾¼ã‚€ã“ã¨ã¯ã§ãã¾ã›ã‚“。ã“れら後者ã®2ã¤ã®ä¿®é£¾åã¯ã€å®Ÿè£…ã®è©³ç´°ã¨è¦‹ãªã•ã‚Œã¦ã„ã‚‹ãŸã‚ã€API仕様ã«ã¯å«ã¾ã‚Œã¾ã›ã‚“。 .LP APIã§ã¯ã€ä¸¦è¡Œæ€§ã‚»ãƒžãƒ³ãƒ†ã‚£ã‚¯ã‚¹ã«ã¤ã„ã¦ã€ã‚ーワード\f2synchronized\fPã«ä¾å˜ã™ã‚‹ã®ã§ã¯ãªãã€ã‚³ãƒ¡ãƒ³ãƒˆã®ä¸»èª¬æ˜Žã¨ã—ã¦ãƒ‰ã‚ュメント化ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ãŸã¨ãˆã°ã€ã€Œ1ã¤ã®\f2Enumeration\fPを複数ã®ã‚¹ãƒ¬ãƒƒãƒ‰ã‹ã‚‰ä¸¦è¡Œã—ã¦ä½¿ç”¨ã™ã‚‹ã“ã¨ã¯ã§ããªã„ã€ã®ã‚ˆã†ã«è¨˜è¿°ã—ã¾ã™ã€‚ドã‚ュメントã«ã¯ã€ã“れらã®ã‚»ãƒžãƒ³ãƒ†ã‚£ã‚¯ã‚¹ã‚’実ç¾ã™ã‚‹æ–¹æ³•ã‚’記述ã—ãªã„ã§ãã ã•ã„。ãŸã¨ãˆã°ã€\f2Hashtable\fPã¯ã‚¹ãƒ¬ãƒƒãƒ‰ã‚»ãƒ¼ãƒ•ã§ã‚ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ãŒã€ã€Œã‚¨ã‚¯ã‚¹ãƒãƒ¼ãƒˆã•ã‚Œã‚‹ã™ã¹ã¦ã®ãƒ¡ã‚½ãƒƒãƒ‰ã‚’åŒæœŸåŒ–ã—ã¦ãれを実ç¾ã™ã‚‹ã€ã®ã‚ˆã†ã«æŒ‡å®šã™ã‚‹æ ¹æ‹ ã¯ã‚ã‚Šã¾ã›ã‚“。ãƒã‚±ãƒƒãƒˆãƒ»ãƒ¬ãƒ™ãƒ«ã§å†…部的ã«åŒæœŸåŒ–ã™ã‚‹æ¨©é™ã‚’ä¿æœ‰ã—ã¦ãŠãå¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ãã†ã™ã‚Œã°ã€ã‚ˆã‚Šé«˜åº¦ãªä¸¦è¡Œæ€§ãŒæä¾›ã•ã‚Œã¾ã™ã€‚ .SH "ドã‚ュメンテーション・コメント" .LP オリジナルã®ã€Œãƒ‰ã‚ュメンテーション・コメントã®ä»•æ§˜ã€ã¯ã€é–¢é€£é …目をå‚ç…§ã—ã¦ãã ã•ã„。 .SS ソース・コードã¸ã®ã‚³ãƒ¡ãƒ³ãƒˆã®æŒ¿å…¥ .LP ソース・コードã®ä»»æ„ã®ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ã¾ãŸã¯ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®å®£è¨€ã®å‰ã«ã€\f2ドã‚ュメンテーション・コメント\fP("doc comments")を記述ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚å„パッケージã«ã‚‚ドã‚ュメンテーション・コメントを作æˆã§ãã¾ã™ã€‚構文ã¯è‹¥å¹²ç•°ãªã‚Šã¾ã™ãŒã€æ¦‚è¦ã«ã‚‚ドã‚ュメンテーション・コメントを作æˆã§ãã¾ã™ã€‚ドã‚ュメンテーション・コメントã¯ã€éžå…¬å¼ã«ã€ŒJavadocコメントã€ã¨å‘¼ã°ã‚Œã¦ã„ã¾ã™(ã“ã®ç”¨èªžã¯å•†æ¨™é–¢é€£ã®ä½¿ç”¨æ–¹æ³•ã«é•å)。ドã‚ュメンテーション・コメントã¯ã€ã‚³ãƒ¡ãƒ³ãƒˆã‚’始ã¾ã‚Šã‚’示ã™æ–‡å—列\f2/**\fPã¨ã€ã‚³ãƒ¡ãƒ³ãƒˆã‚’終ã‚りを示ã™æ–‡å—列\f2*/\fPã®é–“ã«ã‚ã‚‹æ–‡å—ã‹ã‚‰æ§‹æˆã•ã‚Œã¾ã™ã€‚è¡Œé ã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã¯ã€å„è¡Œã«è¨˜è¿°ã§ãã¾ã™ã€‚詳細ã¯ã€å¾Œè¿°ã—ã¾ã™ã€‚コメントã®ãƒ†ã‚ストã¯ã€è¤‡æ•°è¡Œã«ã‚ãŸã£ã¦è¨˜è¿°ã§ãã¾ã™ã€‚ .nf \f3 .fl /** .fl * This is the typical format of a simple documentation comment .fl * that spans two lines. .fl */ .fl \fP .fi .LP スペースを節約ã™ã‚‹ã«ã¯ã€ã‚³ãƒ¡ãƒ³ãƒˆã‚’1è¡Œã«å…¥ã‚Œã¾ã™ã€‚ .nf \f3 .fl /** This comment takes up only one line. */ .fl \fP .fi .LP \f3コメントã®é…ç½®\fP \- ドã‚ュメンテーション・コメントã¯ã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã¾ãŸã¯ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®å®£è¨€ã®ç›´å‰ã«ç½®ã‹ã‚Œã¦ã„ã‚‹ã¨ãã«ã®ã¿èªè˜ã•ã‚Œã¾ã™ã€‚クラスã®ä¾‹ã€ãƒ¡ã‚½ãƒƒãƒ‰ã®ä¾‹ã€ãŠã‚ˆã³ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®ä¾‹ã‚’å‚ç…§ã—ã¦ãã ã•ã„。メソッドã®æœ¬ä½“ã«ç½®ã‹ã‚Œã¦ã„るドã‚ュメンテーション・コメントã¯ç„¡è¦–ã•ã‚Œã¾ã™ã€‚Javadocツールã§ã¯ã€1ã¤ã®å®£è¨€æ–‡ã«ã¤ã1ã¤ã®ãƒ‰ã‚ュメンテーション・コメントã®ã¿ãŒèªè˜ã•ã‚Œã¾ã™ã€‚ .LP よãã‚ã‚‹é–“é•ã„ã¯ã€ã‚¯ãƒ©ã‚¹ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã¨ã‚¯ãƒ©ã‚¹å®£è¨€ã®é–“ã«\f2import\fP文を置ã„ã¦ã—ã¾ã†ã“ã¨ã§ã™ã€‚ã“ã®ã‚ˆã†ãªè¨˜è¿°ã¯ã—ãªã„ã§ãã ã•ã„。ã“ã®ã‚ˆã†ãªã‚¯ãƒ©ã‚¹ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã¯ç„¡è¦–ã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl /** .fl * This is the class comment for the class Whatever. .fl */ .fl .fl import com.sun; // MISTAKE \- Important not to put import statement here .fl .fl public class Whatever { .fl } .fl \fP .fi .LP \f3ドã‚ュメンテーション・コメントã¯\fP\f4主説明\fP\f3ã®å¾Œã«\fP\f4タグ・セクション\fP\f3ãŒç¶šã\fP \- 開始区切り文å—ã§ã‚ã‚‹\f2/**\fPã®å¾Œã‹ã‚‰ã‚¿ã‚°ãƒ»ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã¾ã§ãŒ\f2主説明\fPã«ãªã‚Šã¾ã™ã€‚\f2タグ・セクション\fPã¯ã€å…ˆé æ–‡å—ãŒ\f2@\fPã®è¡Œã§å®šç¾©ã•ã‚Œã‚‹æœ€åˆã®ãƒ–ãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ã‹ã‚‰å§‹ã¾ã‚Šã¾ã™(å…ˆé ã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã€ç©ºç™½æ–‡å—ã€å…ˆé ã®åŒºåˆ‡ã‚Šæ–‡å—\f2/**\fPã¯é™¤ã)。主説明を記述ã›ãšã€ã‚¿ã‚°ãƒ»ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã®ã¿ã®ã‚³ãƒ¡ãƒ³ãƒˆã‚’記述ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚主説明ã¯ã€ã‚¿ã‚°ãƒ»ã‚»ã‚¯ã‚·ãƒ§ãƒ³ä»¥é™ã«ç¶šã‘ã‚‹ã“ã¨ã¯ã§ãã¾ã›ã‚“。タグã®å¼•æ•°ã¯ã€è¤‡æ•°è¡Œã«ã‚ãŸã£ã¦è¨˜è¿°ã§ãã¾ã™ã€‚ã‚¿ã‚°ã®æ•°ã«åˆ¶é™ã¯ã‚ã‚Šã¾ã›ã‚“。何回も記述ã§ãã‚‹ã‚¿ã‚°ã¨ã€1回ã—ã‹è¨˜è¿°ã§ããªã„ã‚¿ã‚°ãŒã‚ã‚Šã¾ã™ã€‚ãŸã¨ãˆã°ã€æ¬¡ã®\f2@see\fPã‹ã‚‰ã‚¿ã‚°ãƒ»ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã¯å§‹ã¾ã‚Šã¾ã™ã€‚ .nf \f3 .fl /** .fl * This sentence would hold the main description for this doc comment. .fl * @see java.lang.Object .fl */ .fl \fP .fi .LP \f3ブãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ã¨ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ã‚¿ã‚°\fP \- \f2ã‚¿ã‚°\fPã¯ã€JavadocツールãŒå‡¦ç†ã§ãã‚‹ã€ãƒ‰ã‚ュメンテーション・コメント内ã®ç‰¹åˆ¥ãªã‚ーワードã§ã™ã€‚ã‚¿ã‚°ã«ã¯2ã¤ã®ã‚¿ã‚¤ãƒ—ãŒã‚ã‚Šã¾ã™ã€‚1ã¤ã¯\f2@tag\fPã®ã‚ˆã†ã«è¡¨è¨˜ã•ã‚Œã‚‹ãƒ–ãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°(「スタンドアãƒãƒ³ãƒ»ã‚¿ã‚°ã€ã¨ã‚‚呼ã°ã‚Œã‚‹)ã€ã‚‚ã†1ã¤ã¯\f2{@tag}\fPã®ã‚ˆã†ã«ä¸æ‹¬å¼§ã§å›²ã‚“ã§è¡¨è¨˜ã•ã‚Œã‚‹ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ã‚¿ã‚°ã§ã™ã€‚ブãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ãŒè§£é‡ˆã•ã‚Œã‚‹ã«ã¯ã€è¡Œé ã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã€ç©ºç™½æ–‡å—ã€åŒºåˆ‡ã‚Šæ–‡å—(\f2/**\fP)を除ã„ã¦ã€è¡Œã®å…ˆé ã«ç½®ãå¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã“ã‚Œã¯ã€\f2@\fPæ–‡å—をテã‚スト内ã®åˆ¥ã®å ´æ‰€ã§ä½¿ç”¨ã—ã¦ã‚‚ã€ã‚¿ã‚°ã®é–‹å§‹ã¨ã—ã¦è§£é‡ˆã•ã‚Œãªã„ã“ã¨ã‚’æ„味ã—ã¦ã„ã¾ã™ã€‚\f2@\fPæ–‡å—を使用ã—ã¦è¡Œã‚’開始ã—ã¦ã‚‚ã€ãã‚ŒãŒè§£é‡ˆã•ã‚Œãªã„よã†ã«ã™ã‚‹ã«ã¯ã€HTMLエンティティ\f2@\fPを使用ã—ã¾ã™ã€‚ãã‚Œãžã‚Œã®ãƒ–ãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ã«ã¯ã€é–¢é€£ä»˜ã‘られãŸãƒ†ã‚ストãŒã‚ã‚Šã¾ã™ã€‚ã“ã®ãƒ†ã‚ストã¯ã€ã‚¿ã‚°ã®å¾Œã‹ã‚‰ã€æ¬¡ã®ã‚¿ã‚°ã®å‰ã€ã¾ãŸã¯ãƒ‰ã‚ュメンテーション・コメントã®æœ€å¾Œã¾ã§ã®é–“ã«è¨˜è¿°ã•ã‚ŒãŸãƒ†ã‚ストã§ã™(ã‚¿ã‚°ã¾ãŸã¯ã‚³ãƒ¡ãƒ³ãƒˆåŒºåˆ‡ã‚Šæ–‡å—を除ã)。ã“ã®é–¢é€£ãƒ†ã‚ストã¯ã€è¤‡æ•°è¡Œã«ã‚ãŸã£ã¦è¨˜è¿°ã§ãã¾ã™ã€‚インライン・タグã¯ã€ãƒ†ã‚ストを記述ã§ãã‚‹å ´æ‰€ã§ã‚ã‚Œã°ã©ã“ã«ã§ã‚‚ç½®ãã“ã¨ãŒã§ãã€è§£é‡ˆã•ã‚Œã¾ã™ã€‚次ã®ä¾‹ã«ã¯ãƒ–ãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°\f2@deprecated\fPã¨ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ã‚¿ã‚°\f2{@link}\fPãŒå«ã¾ã‚Œã¦ã„ã¾ã™ã€‚ .nf \f3 .fl /** .fl * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} .fl */ .fl \fP .fi .LP \f3コメントã¯HTMLã§è¨˜è¿°ã™ã‚‹\fP \- テã‚ストã¯HTMLã§è¨˜è¿°ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã“ã‚Œã¯ã€HTMLã®ã‚¨ãƒ³ãƒ†ã‚£ãƒ†ã‚£ã‚’使用ã™ã‚‹å¿…è¦ãŒã‚ã‚‹ã“ã¨ã€ãŠã‚ˆã³HTMLタグを使用ã§ãã‚‹ã“ã¨ã‚’æ„味ã—ã¾ã™ã€‚HTMLã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã¨ã—ã¦ã¯ã€ä½¿ç”¨ã™ã‚‹ãƒ–ラウザãŒã‚µãƒãƒ¼ãƒˆã™ã‚‹ä»»æ„ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã‚’使用ã§ãã¾ã™ã€‚標準ドックレットã¯ã€ã‚«ã‚¹ã‚±ãƒ¼ãƒ‡ã‚£ãƒ³ã‚°ãƒ»ã‚¹ã‚¿ã‚¤ãƒ«ãƒ»ã‚·ãƒ¼ãƒˆãŠã‚ˆã³ãƒ•ãƒ¬ãƒ¼ãƒ ã‚’å«ã‚ã€ãƒ‰ã‚ュメンテーション・コメント以外ã®éƒ¨åˆ†ã§HTML 3.2ã«æº–æ‹ ã—ãŸã‚³ãƒ¼ãƒ‰ã‚’生æˆã™ã‚‹ã‚ˆã†ã«ä½œæˆã•ã‚Œã¦ã„ã¾ã™ã€‚(ãŸã ã—ã€ãƒ•ãƒ¬ãƒ¼ãƒ ・セット対応ã®ãŸã‚ã€ç”Ÿæˆã•ã‚Œã‚‹å„ファイルã«ã¯ã€ŒHTML 4.0ã€ã¨å…ˆé ã«è¨˜è¿°ã•ã‚Œã¾ã™ã€‚) .LP ãŸã¨ãˆã°ã€ã‚ˆã‚Šå°ã•ã„(\f2<\fP)記å·ãŠã‚ˆã³ã‚ˆã‚Šå¤§ãã„(\f2>\fP)記å·ã®ã‚¨ãƒ³ãƒ†ã‚£ãƒ†ã‚£ã¯ã€\f2<\fPãŠã‚ˆã³\f2>\fPã¨è¨˜è¿°ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚åŒæ§˜ã«ã€ã‚¢ãƒ³ãƒ‘サンド(\f2&\fP)ã¯\f2&\fPã¨è¨˜è¿°ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚次ã®ä¾‹ã§ã¯ã€å¤ªå—ã®HTMLã‚¿ã‚°\f2<b>\fPを使用ã—ã¦ã„ã¾ã™ã€‚ .LP 次ã«ã€ãƒ‰ã‚ュメンテーション・コメントを示ã—ã¾ã™ã€‚ .nf \f3 .fl /** .fl * This is a <b>doc</b> comment. .fl * @see java.lang.Object .fl */ .fl \fP .fi .LP \f3è¡Œé ã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯\fP \- Javadocã«ã‚ˆã‚‹ãƒ‰ã‚ュメンテーション・コメントã®è§£æžæ™‚ã«ã€å„è¡Œã®å…ˆé ã«ã‚るアスタリスク(\f2*\fP)æ–‡å—ã¯ç ´æ£„ã•ã‚Œã¾ã™ã€‚最åˆã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯(\f2*\fP)æ–‡å—よりå‰ã«ã‚ã‚‹ç©ºç™½ã‚„ã‚¿ãƒ–ã‚‚ç ´æ£„ã•ã‚Œã¾ã™ã€‚ãƒãƒ¼ã‚¸ãƒ§ãƒ³1.4ã‹ã‚‰ã¯ã€è¡Œã®å…ˆé ã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã‚’çœç•¥ã—ã¦ã‚‚ã€å…ˆé ã®ç©ºç™½æ–‡å—ã¯å‰Šé™¤ã•ã‚Œãªããªã‚Šã¾ã—ãŸã€‚ã“ã®ãŸã‚ã€ã‚³ãƒ¼ãƒ‰ä¾‹ã‚’直接ドã‚ュメンテーション・コメントã®\f2<PRE>\fPタグ内ã«å¼µã‚Šä»˜ã‘ã¦ã‚‚ã€ã‚¤ãƒ³ãƒ‡ãƒ³ãƒˆãŒä¿æŒã•ã‚Œã¾ã™ã€‚通常ã€ãƒ–ラウザã¯ã€ç©ºç™½æ–‡å—をタブよりも一律ã«è§£é‡ˆã—ã¾ã™ã€‚インデントã®èµ·ç‚¹ã¯(区切り文å—\f2/**\fPã¾ãŸã¯\f2<PRE>\fPã‚¿ã‚°ã§ã¯ãªã)左マージンã«ãªã‚Šã¾ã™ã€‚ .LP \f3最åˆã®æ–‡\fP \- å„ドã‚ュメンテーション・コメントã®æœ€åˆã®æ–‡ã¯ã€å®£è¨€ã•ã‚Œã¦ã„るエンティティã«é–¢ã™ã‚‹ç°¡æ½”ã‹ã¤å®Œå…¨ãªè¦ç´„æ–‡ã§ã‚ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã“ã®æ–‡ã¯ã€ç©ºç™½ã€ã‚¿ãƒ–ã€ã¾ãŸã¯è¡Œçµ‚了文å—ãŒç¶šã最åˆã®ãƒ”リオドã€ã¾ãŸã¯æœ€åˆã®ãƒ–ãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ãŒã‚ã‚‹ä½ç½®ã§çµ‚ã‚ã‚Šã¾ã™ã€‚最åˆã®æ–‡ã¯ã€Javadocツールã«ã‚ˆã£ã¦HTMLページã®å…ˆé ã«ã‚るメンãƒãƒ¼ã®æ¦‚è¦ã®éƒ¨åˆ†ã«ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ .LP \f3複数フィールドã®å®£è¨€\fP \- Javaã§ã¯ã€1ã¤ã®æ–‡ã§è¤‡æ•°ã®ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã‚’宣言ã§ãã¾ã™ã€‚ãŸã ã—ã€ã“ã®æ–‡ã«ã¯ã€1ã¤ã®ãƒ‰ã‚ュメンテーション・コメントã—ã‹è¨˜è¿°ã§ãã¾ã›ã‚“。ãã®ã‚³ãƒ¡ãƒ³ãƒˆãŒã€ã™ã¹ã¦ã®ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã«å¯¾ã—ã¦ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã”ã¨ã«ãƒ‰ã‚ュメンテーション・コメントを記述ã™ã‚‹å¿…è¦ãŒã‚ã‚‹å ´åˆã¯ã€å„フィールドを別々ã®æ–‡ã§å®£è¨€ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ãŸã¨ãˆã°ã€æ¬¡ã®ãƒ‰ã‚ュメンテーション・コメントã¯ã€1ã¤ã®å®£è¨€ã¨ã—ã¦è¨˜è¿°ã™ã‚‹ã¨ä¸é©åˆ‡ã§ã™ã€‚ã“ã®å ´åˆã¯ã€å®£è¨€ã‚’2ã¤ã«åˆ†ã‘ã‚‹ã“ã¨ã‚’ãŠè–¦ã‚ã—ã¾ã™ã€‚ .nf \f3 .fl /** .fl * The horizontal and vertical distances of point (x,y) .fl */ .fl public int x, y; // Avoid this .fl \fP .fi .LP 上ã®ã‚³ãƒ¼ãƒ‰ã‹ã‚‰ã¯ã€æ¬¡ã®ã‚ˆã†ãªãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl public int \fP\f3x\fP .fl .fi .RS 3 The horizontal and vertical distances of point (x,y) .RE .nf \f3 .fl public int \fP\f3y\fP .fl .fi .RS 3 The horizontal and vertical distances of point (x,y) .RE .LP \f3見出ã—ã‚¿ã‚°ã®ä½¿ç”¨ã«ã¯è¦æ³¨æ„\fP \- メンãƒãƒ¼ã«å¯¾ã—ã¦ãƒ‰ã‚ュメンテーション・コメントを記述ã™ã‚‹ã¨ãã«ã¯ã€<H1>ã‚„<H2>ãªã©ã®HTML見出ã—タグを使用ã—ãªã„ã“ã¨ã‚’ãŠè–¦ã‚ã—ã¾ã™ã€‚Javadocツールã¯ã€å®Œå…¨ãªæ§‹é€ 化ドã‚ュメントを作æˆã™ã‚‹ã®ã§ã€ã“ã®ã‚ˆã†ãªæ§‹é€ 化タグãŒä½¿ç”¨ã•ã‚Œã¦ã„ã‚‹ã¨ã€ç”Ÿæˆãƒ‰ã‚ュメントã®å½¢å¼ãŒæ‚ªå½±éŸ¿ã‚’å—ã‘ã‚‹ã“ã¨ãŒã‚ã‚Šã¾ã™ã€‚ãŸã ã—ã€ã‚¯ãƒ©ã‚¹ã‚„パッケージã®ã‚³ãƒ¡ãƒ³ãƒˆã§ã¯ã€ã“れらã®è¦‹å‡ºã—を使用ã—ã¦ç‹¬è‡ªã®æ§‹é€ を指定ã—ã¦ã‹ã¾ã„ã¾ã›ã‚“。 .SS メソッド・コメントã®è‡ªå‹•ã‚³ãƒ”ー .LP Javadocツールã«ã¯ã€æ¬¡ã®2ã¤ã®å ´åˆã«ã€ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ãƒ¡ã‚½ãƒƒãƒ‰ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã‚’コピーã¾ãŸã¯ã€Œç¶™æ‰¿ã€ã™ã‚‹æ©Ÿèƒ½ãŒã‚ã‚Šã¾ã™ã€‚コンストラクタã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã€ãŠã‚ˆã³ãƒã‚¹ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã¯ã€ãƒ‰ã‚ュメンテーション・コメントを継承ã—ã¾ã›ã‚“。 .RS 3 .TP 2 o \f3自動的ã«ã‚³ãƒ¡ãƒ³ãƒˆã‚’継承ã—ã¦è¦‹ã¤ã‹ã‚‰ãªã„テã‚ストを埋ã‚ã‚‹\fP \- 主説明ã€\f2@return\fPã‚¿ã‚°ã€\f2@param\fPã‚¿ã‚°ã€ã¾ãŸã¯\f2@throws\fP ã‚¿ã‚°ãŒãƒ¡ã‚½ãƒƒãƒ‰ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã«è¦‹ã¤ã‹ã‚‰ãªã„å ´åˆã€Javadocツールã¯ã€ãƒ¡ã‚½ãƒƒãƒ‰ã‚’オーãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã¾ãŸã¯å®Ÿè£…ã—ã¦ã„ã‚‹å ´åˆã¯ãã®ãƒ¡ã‚½ãƒƒãƒ‰ã‹ã‚‰ã€å¯¾å¿œã™ã‚‹ä¸»èª¬æ˜Žã¾ãŸã¯ã‚¿ã‚°ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã‚’ã€æ¬¡ã®ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ ã«å¾“ã£ã¦ã‚³ãƒ”ーã—ã¾ã™ã€‚ .LP 厳密ã«ã¯ã€ç‰¹å®šã®ãƒ‘ラメータã®\f2@param\fPã‚¿ã‚°ãŒè¦‹ã¤ã‹ã‚‰ãªã„å ´åˆã€ãã®ãƒ‘ラメータã®ã‚³ãƒ¡ãƒ³ãƒˆãŒã€ä¸Šä½ã®ç¶™æ‰¿éšŽå±¤ã®ãƒ¡ã‚½ãƒƒãƒ‰ã‹ã‚‰ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚特定ã®ä¾‹å¤–ã®\f2@throws\fPã‚¿ã‚°ãŒè¦‹ã¤ã‹ã‚‰ãªã„å ´åˆã€ãã®ä¾‹å¤–ãŒå®£è¨€ã•ã‚Œã¦ã„ã‚‹å ´åˆã«\f2ã‹ãŽã‚Š\fPã€\f2@throws\fPã‚¿ã‚°ãŒã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ .LP ã“ã®å‹•ä½œã¯ãƒãƒ¼ã‚¸ãƒ§ãƒ³1.3以å‰ã®å‹•ä½œã¨ã¯å¯¾ç…§çš„ã§ã™ã€‚ã“ã‚Œã¾ã§ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã§ã¯ã€ä¸»èª¬æ˜Žã¾ãŸã¯ã‚¿ã‚°ãŒå˜åœ¨ã™ã‚Œã°ã€ã‚³ãƒ¡ãƒ³ãƒˆã¯ä¸€åˆ‡ç¶™æ‰¿ã•ã‚Œã¾ã›ã‚“ã§ã—ãŸã€‚ .TP 2 o \f3{@inheritDoc}ã‚¿ã‚°ã‚’å«ã‚€ã‚³ãƒ¡ãƒ³ãƒˆã‚’明示的ã«ç¶™æ‰¿ã™ã‚‹\fP \- インライン・タグ\f2{@inheritDoc}\fPã‚’ã€ãƒ¡ã‚½ãƒƒãƒ‰ã®ä¸»èª¬æ˜Žå†…ã¾ãŸã¯\f2@return\fPã‚¿ã‚°ã€\f2@param\fPã‚¿ã‚°ã€ã¾ãŸã¯\f2@throws\fPã®ã„ãšã‚Œã‹ã®ã‚¿ã‚°ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆå†…ã«æŒ¿å…¥ã—ã¾ã™ã€‚対応ã™ã‚‹ç¶™æ‰¿ã•ã‚ŒãŸä¸»èª¬æ˜Žã¾ãŸã¯ã‚¿ã‚°ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆãŒãã®ä½ç½®ã«ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ .RE .LP ドã‚ュメンテーション・コメントを実際ã«ã‚³ãƒ”ーã«åˆ©ç”¨ã™ã‚‹ã«ã¯ã€ç¶™æ‰¿ã—ãŸãƒ¡ã‚½ãƒƒãƒ‰ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒ\-sourcepathã§æŒ‡å®šã—ãŸãƒ‘スã®ã¿ã«ç½®ã‹ã‚Œã¦ã„ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚コマンドラインã§ã€ã‚¯ãƒ©ã‚¹ã‚‚パッケージも渡ã™å¿…è¦ã¯ã‚ã‚Šã¾ã›ã‚“。ã“ã®ç‚¹ã¯ã€ã‚¯ãƒ©ã‚¹ãŒãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ã§ã‚ã‚‹ã“ã¨ãŒå¿…è¦ã ã£ãŸ1.3.x以å‰ã®ãƒªãƒªãƒ¼ã‚¹ã¨ç•°ãªã‚Šã¾ã™ã€‚ .LP \f3クラスãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‹ã‚‰ã®ç¶™æ‰¿\fP \- クラスãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‹ã‚‰ç¶™æ‰¿ã™ã‚‹æ¬¡ã®3ã¤ã®å ´åˆã«ã€ã‚³ãƒ¡ãƒ³ãƒˆã®ç¶™æ‰¿ãŒè¡Œã‚ã‚Œã¾ã™ã€‚ .RS 3 .TP 2 o クラスã®ãƒ¡ã‚½ãƒƒãƒ‰ãŒã‚¹ãƒ¼ãƒ‘ークラスã®ãƒ¡ã‚½ãƒƒãƒ‰ã‚’オーãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã—ã¦ã„ã‚‹å ´åˆ .TP 2 o インタフェースã®ãƒ¡ã‚½ãƒƒãƒ‰ãŒã‚¹ãƒ¼ãƒ‘ーインタフェースã®ãƒ¡ã‚½ãƒƒãƒ‰ã‚’オーãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã—ã¦ã„ã‚‹å ´åˆ .TP 2 o クラスã®ãƒ¡ã‚½ãƒƒãƒ‰ãŒã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ãƒ¡ã‚½ãƒƒãƒ‰ã‚’実装ã—ã¦ã„ã‚‹å ´åˆ .RE .LP 最åˆã®2ã¤ã®ã‚±ãƒ¼ã‚¹(メソッドãŒã‚ªãƒ¼ãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã—ã¦ã„ã‚‹å ´åˆ)ã§ã¯ã€Javadocツールã¯ã€ãã®ã‚³ãƒ¡ãƒ³ãƒˆãŒç¶™æ‰¿ã•ã‚Œã¦ã„ã‚‹ã‹ã©ã†ã‹ã«ã‹ã‹ã‚らãšã€ã‚ªãƒ¼ãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã—ã¦ã„るメソッドã®ãƒ‰ã‚ュメント内ã«ã€Œã‚ªãƒ¼ãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã€ã¨ã„ã†å°è¦‹å‡ºã—を生æˆã—ã€ã‚ªãƒ¼ãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã•ã‚Œã¦ã„るメソッドã¸ã®ãƒªãƒ³ã‚¯ã‚’書ãè¾¼ã¿ã¾ã™ã€‚ .LP 3ã¤ç›®ã®ã‚±ãƒ¼ã‚¹(特定ã®ã‚¯ãƒ©ã‚¹ã®ãƒ¡ã‚½ãƒƒãƒ‰ãŒã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ãƒ¡ã‚½ãƒƒãƒ‰ã‚’実装ã—ã¦ã„ã‚‹å ´åˆ)ã§ã¯ã€Javadocツールã¯ã€ã‚ªãƒ¼ãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã—ã¦ã„るメソッドã®ãƒ‰ã‚ュメント内ã«ã€Œå®šç¾©ã€ã¨ã„ã†å°è¦‹å‡ºã—を生æˆã—ã€å®Ÿè£…ã•ã‚Œã¦ã„るメソッドã¸ã®ãƒªãƒ³ã‚¯ã‚’書ãè¾¼ã¿ã¾ã™ã€‚ã“ã‚Œã¯ã€ã‚³ãƒ¡ãƒ³ãƒˆãŒç¶™æ‰¿ã•ã‚Œã¦ã„ã‚‹ã‹ã©ã†ã‹ã«ã‹ã‹ã‚ã‚Šã¾ã›ã‚“。 .LP \f3メソッド・コメントãŒç¶™æ‰¿ã•ã‚Œã‚‹ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ \fP \- ã‚るメソッドã«ãƒ‰ã‚ュメンテーション・コメントãŒè¨˜è¿°ã•ã‚Œã¦ã„ãªã„å ´åˆã€ã¾ãŸã¯{@inheritDoc}ã‚¿ã‚°ãŒã‚ã‚‹å ´åˆã€Javadocツールã¯ã€æ¬¡ã®ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ を使用ã—ã¦é©åˆ‡ãªã‚³ãƒ¡ãƒ³ãƒˆã‚’検索ã—ã¾ã™ã€‚ã“ã®ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ ã¯ã€æœ€ã‚‚厳密ã«é©åˆ‡ãªãƒ‰ã‚ュメンテーション・コメントを検索ã§ãるよã†ã«è¨è¨ˆã•ã‚Œã¦ãŠã‚Šã€ã‚¹ãƒ¼ãƒ‘ークラスよりもインタフェースãŒå„ªå…ˆã•ã‚Œã‚‹ã‚ˆã†ã«ãªã£ã¦ã„ã¾ã™ã€‚ .RS 3 .TP 3 1. 直接ã«å®Ÿè£…ã•ã‚Œã¦ã„ã‚‹(ã¾ãŸã¯ã€æ‹¡å¼µã•ã‚Œã¦ã„ã‚‹)インタフェースをã€ãƒ¡ã‚½ãƒƒãƒ‰ã®å®£è¨€ã§ã€Œimplementsã€(ã¾ãŸã¯ã€Œextendsã€)ã¨ã„ã†èªžã®å¾Œã«å‡ºç¾ã™ã‚‹é †åºã§ã€1ã¤ãšã¤èª¿ã¹ã¾ã™ã€‚ã“ã®ãƒ¡ã‚½ãƒƒãƒ‰ã«ã¤ã„ã¦æœ€åˆã«è¦‹ã¤ã‹ã£ãŸãƒ‰ã‚ュメンテーション・コメントを採用ã—ã¾ã™ã€‚ .TP 3 2. æ‰‹é †1ã§ãƒ‰ã‚ュメンテーション・コメントãŒè¦‹ã¤ã‹ã‚‰ãªã‹ã£ãŸå ´åˆã¯ã€ç›´æŽ¥å®Ÿè£…ã•ã‚Œã¦ã„ã‚‹(ã¾ãŸã¯ã€æ‹¡å¼µã•ã‚Œã¦ã„ã‚‹)インタフェースã®ãã‚Œãžã‚Œã«å¯¾ã—ã¦ã€ã“ã®ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ 全体をå†å¸°çš„ã«é©ç”¨ã—ã¾ã™(ãã®éš›ã®é †åºã¯ã€æ‰‹é †1ã§ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‚’調ã¹ãŸã¨ãã®é †åºã¨åŒã˜)。 .TP 3 3. æ‰‹é †2ã§ãƒ‰ã‚ュメンテーション・コメントãŒè¦‹ã¤ã‹ã‚‰ãªã‹ã£ãŸå ´åˆã§ã€ã“ã®ã‚¯ãƒ©ã‚¹ãŒObject以外ã®ã‚¯ãƒ©ã‚¹ã§ã‚ã‚‹(インタフェースã§ã¯ãªã„)å ´åˆã¯ã€æ¬¡ã®ã‚ˆã†ã«å‡¦ç†ã—ã¾ã™ã€‚ .RS 3 .TP 3 a. スーパークラスã«ã“ã®ãƒ¡ã‚½ãƒƒãƒ‰ã«ã¤ã„ã¦ã®ãƒ‰ã‚ュメンテーション・コメントãŒè¨˜è¿°ã•ã‚Œã¦ã„ã‚‹å ´åˆã¯ã€ãã®ã‚³ãƒ¡ãƒ³ãƒˆã‚’採用ã—ã¾ã™ã€‚ .TP 3 b. æ‰‹é †3aã§ãƒ‰ã‚ュメンテーション・コメントãŒè¦‹ã¤ã‹ã‚‰ãªã‹ã£ãŸå ´åˆã¯ã€ã‚¹ãƒ¼ãƒ‘ークラスã«å¯¾ã—ã¦ã€ã“ã®ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ 全体をå†å¸°çš„ã«é©ç”¨ã—ã¾ã™ã€‚ .RE .RE .SH "javadocã‚¿ã‚°" .LP Javadocツールã¯ã€Javaã®ãƒ‰ã‚ュメンテーション・コメント内ã«åŸ‹ã‚è¾¼ã¾ã‚ŒãŸç‰¹åˆ¥ãªã‚¿ã‚°ã‚’解æžã—ã¾ã™ã€‚ã“れらã®ãƒ‰ã‚ュメンテーション・タグを使用ã™ã‚‹ã¨ã€å®Œå…¨ãªæ•´å½¢å¼ã®APIをソース・コードã‹ã‚‰è‡ªå‹•çš„ã«ç”Ÿæˆã§ãã¾ã™ã€‚ã‚¿ã‚°ã¯ã€Œã‚¢ãƒƒãƒˆãƒžãƒ¼ã‚¯ã€è¨˜å·(\f2@\fP)ã§å§‹ã¾ã‚Šã€å¤§æ–‡å—ã¨å°æ–‡å—ãŒåŒºåˆ¥ã•ã‚Œã¾ã™ã€‚ã“れらã®ã‚¿ã‚°ã¯ã€è¡¨ç¤ºã•ã‚Œã¦ã„ã‚‹ã¨ãŠã‚Šã«å¤§æ–‡å—ã¨å°æ–‡å—を使用ã—ã¦å…¥åŠ›ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã‚¿ã‚°ã¯ã€è¡Œã®å…ˆé (å…ˆé ã®ç©ºç™½æ–‡å—ã¨çœç•¥å¯èƒ½ãªã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã®å¾Œ)ã«ç½®ãå¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ãã†ã—ãªã„ã¨ã€é€šå¸¸ã®ãƒ†ã‚ストã¨ã—ã¦æ‰±ã‚ã‚Œã¾ã™ã€‚慣例ã¨ã—ã¦ã€åŒã˜åå‰ã®ã‚¿ã‚°ã¯1箇所ã«ã¾ã¨ã‚ã¾ã™ã€‚ãŸã¨ãˆã°ã€\f2@see\fPã‚¿ã‚°ãŒè¤‡æ•°ã‚ã‚‹å ´åˆã¯ã€ã™ã¹ã¦åŒã˜å ´æ‰€ã«ã¾ã¨ã‚ã¦é…ç½®ã—ã¾ã™ã€‚ .LP ã‚¿ã‚°ã«ã¯æ¬¡ã®2ã¤ã®ã‚¿ã‚¤ãƒ—ãŒã‚ã‚Šã¾ã™ã€‚ .RS 3 .TP 2 o \f3ブãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°\fP \- 主説明ã«ç¶šãタグ・セクション内ã«ã®ã¿è¨˜è¿°å¯èƒ½ã€‚ブãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ã¯ã€\f2@tag\fPã®å½¢å¼ã‚’ã¨ã‚Šã¾ã™ã€‚ .TP 2 o \f3インライン・タグ\fP \- 主説明内ã€ã¾ãŸã¯ãƒ–ãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ã®ã‚³ãƒ¡ãƒ³ãƒˆå†…ã«è¨˜è¿°å¯èƒ½ã€‚インライン・タグã¯ã€\f2{@tag}\fPã®ã‚ˆã†ã«ä¸æ‹¬å¼§ã§å›²ã¿ã¾ã™ã€‚ .RE .LP ç¾æ™‚点ã§æœ‰åŠ¹ãªã‚¿ã‚°ã¯ã€æ¬¡ã®ã¨ãŠã‚Šã§ã™ã€‚ .LP .TS .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 .de 35 .ps \n(.s .vs \n(.vu .in \n(.iu .if \n(.u .fi .if \n(.j .ad .if \n(.j=0 .na .. .nf .nr #~ 0 .if n .nr #~ 0.6n .ds #d .d .if \(ts\n(.z\(ts\(ts .ds #d nl .fc .nr 33 \n(.s .rm 80 81 .nr 80 0 .nr 38 \w\f3ã‚¿ã‚°\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@author\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2{@code}\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2{@docRoot}\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@deprecated\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@exception\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2{@inheritDoc}\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2{@link}\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2{@linkplain}\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2{@literal}\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@param\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@return\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@see\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@serial\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@serialData\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@serialField\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@since\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@throws\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2{@value}\fP .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \w\f2@version\fP .if \n(80<\n(38 .nr 80 \n(38 .80 .rm 80 .nr 81 0 .nr 38 \w\f3å°Žå…¥ã•ã‚ŒãŸJDK/SDK\fP .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.0 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.5 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.3 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.0 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.0 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.4 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.2 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.4 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.5 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.0 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.0 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.0 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.2 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.2 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.2 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.1 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.2 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.4 .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \w1.0 .if \n(81<\n(38 .nr 81 \n(38 .81 .rm 81 .nr 38 1n .nr 79 0 .nr 40 \n(79+(0*\n(38) .nr 80 +\n(40 .nr 41 \n(80+(3*\n(38) .nr 81 +\n(41 .nr TW \n(81 .if t .if \n(TW>\n(.li .tm Table at line 861 file Input is too wide - \n(TW units .fc .nr #T 0-1 .nr #a 0-1 .eo .de T# .ds #d .d .if \(ts\n(.z\(ts\(ts .ds #d nl .mk ## .nr ## -1v .ls 1 .ls .. .ec .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f3ã‚¿ã‚°\fP\h'|\n(41u'\f3å°Žå…¥ã•ã‚ŒãŸJDK/SDK\fP .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@author\fP\h'|\n(41u'1.0 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2{@code}\fP\h'|\n(41u'1.5 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2{@docRoot}\fP\h'|\n(41u'1.3 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@deprecated\fP\h'|\n(41u'1.0 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@exception\fP\h'|\n(41u'1.0 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2{@inheritDoc}\fP\h'|\n(41u'1.4 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2{@link}\fP\h'|\n(41u'1.2 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2{@linkplain}\fP\h'|\n(41u'1.4 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2{@literal}\fP\h'|\n(41u'1.5 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@param\fP\h'|\n(41u'1.0 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@return\fP\h'|\n(41u'1.0 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@see\fP\h'|\n(41u'1.0 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@serial\fP\h'|\n(41u'1.2 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@serialData\fP\h'|\n(41u'1.2 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@serialField\fP\h'|\n(41u'1.2 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@since\fP\h'|\n(41u'1.1 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@throws\fP\h'|\n(41u'1.2 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2{@value}\fP\h'|\n(41u'1.4 .ta \n(80u \n(81u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f2@version\fP\h'|\n(41u'1.0 .fc .nr T. 1 .T# 1 .35 .TE .if \n-(b.=0 .nr c. \n(.c-\n(d.-42 .LP カスタム・タグã«ã¤ã„ã¦ã¯ã€\-tagオプションをå‚ç…§ã—ã¦ãã ã•ã„。 .RS 3 .TP 3 @author\ name\-text \-authorオプションãŒä½¿ç”¨ã•ã‚Œã¦ã„ã‚‹å ´åˆã€ç”Ÿæˆãƒ‰ã‚ュメントã«ã€Œä½œæˆè€…ã€ã‚¨ãƒ³ãƒˆãƒªã‚’è¿½åŠ ã—ã¦ã€æŒ‡å®šã•ã‚ŒãŸ\f2name\-text\fPを書ãè¾¼ã¿ã¾ã™ã€‚1ã¤ã®ãƒ‰ã‚ュメンテーション・コメントã«è¤‡æ•°ã®\f2@author\fPã‚¿ã‚°ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚1ã¤ã®\f2@author\fPã‚¿ã‚°ã«1ã¤ã®åå‰ã‚’指定ã™ã‚‹ã“ã¨ã‚‚ã€è¤‡æ•°ã®åå‰ã‚’指定ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚å‰è€…ã®å ´åˆã¯ã€Javadocツールã«ã‚ˆã£ã¦åå‰ã¨åå‰ã®é–“ã«ã‚«ãƒ³ãƒž(\f2,\fP)ã¨ç©ºç™½æ–‡å—ãŒæŒ¿å…¥ã•ã‚Œã¾ã™ã€‚後者ã®å ´åˆã¯ã€ãƒ†ã‚スト全体ãŒã€è§£æžã•ã‚Œã‚‹ã“ã¨ãªãã€ç”Ÿæˆãƒ‰ã‚ュメントã«ãã®ã¾ã¾ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€ã‚«ãƒ³ãƒžã§ã¯ãªãã€å„言語ã«å¯¾å¿œã—ãŸåå‰åŒºåˆ‡ã‚Šæ–‡å—を使用ã™ã‚‹å¿…è¦ãŒã‚ã‚‹ã¨ãã¯ã€1ã¤ã®ã‚¿ã‚°ã«è¤‡æ•°ã®åå‰ã‚’指定ã—ã¦ãã ã•ã„。 .RE .LP 詳細ã¯ã€ã‚¿ã‚°ã‚’使用ã§ãã‚‹å ´æ‰€ãŠã‚ˆã³ .na \f2@authorã‚¿ã‚°ã®ãƒ‰ã‚ュメント\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@authorã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .LP .RS 3 .TP 3 @deprecated\ deprecated\-text 注æ„: @Deprecated注釈を使用ã—ã¦ã€ãƒ—ãƒã‚°ãƒ©ãƒ è¦ç´ ã‚’éžæŽ¨å¥¨ã«ã§ãã¾ã™ã€‚ .RE .LP ã“ã®APIã¯å‹•ä½œã—続ã‘ã¾ã™ãŒã€ã“ã®APIを使用ã—ãªã„ã“ã¨ã‚’è–¦ã‚ã‚‹ã‚³ãƒ¡ãƒ³ãƒˆã‚’è¿½åŠ ã—ã¾ã™ã€‚Javadocツールã¯ã€\f2deprecated\-text\fPを主説明ã®å‰ã«ç§»å‹•ã—ã¦ã‚¤ã‚¿ãƒªãƒƒã‚¯ã«ã—ã€ãã®å‰ã«å¤ªå—ã®è¦å‘Šã€ŒæŽ¨å¥¨ã•ã‚Œã¦ã„ã¾ã›ã‚“。ã€ã‚’è¿½åŠ ã—ã¾ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€ã™ã¹ã¦ã®ãƒ‰ã‚ュメンテーション・コメントã€ã¤ã¾ã‚Šæ¦‚è¦ã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ãŠã‚ˆã³ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã§æœ‰åŠ¹ã§ã™ã€‚ .LP \f2deprecated\-text\fPã®æœ€åˆã®æ–‡ã§ã¯ã€å°‘ãªãã¨ã‚‚ã€ãã®APIãŒæŽ¨å¥¨ã•ã‚Œãªããªã£ãŸæ™‚期ã¨ã€ä»£æ›¿ã¨ã—ã¦ä½¿ç”¨ã™ã‚‹APIをユーザーã«æ示ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚Javadocツールã¯ã€ã“ã®æœ€åˆã®æ–‡ã®ã¿ã‚’ã€æ¦‚è¦ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã¨ç´¢å¼•ã«ã‚³ãƒ”ーã—ã¾ã™ã€‚ãã®å¾Œã®æ–‡ã§ã¯ã€æŽ¨å¥¨ã•ã‚Œãªã„ç†ç”±ã‚’説明ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚ã‹ã‚ã‚Šã®APIを指ã—示ã™\f2{@link}\fPã‚¿ã‚°(Javadoc 1.2以é™ã®å ´åˆ)ã‚’å«ã‚ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .LP 詳細ã¯ã€ .na \f2@deprecatedã‚¿ã‚°ã®ãƒ‰ã‚ュメント\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@deprecatedã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .RS 3 .TP 2 o Javadoc 1.2以é™ã§ã¯ã€\f2{@link}\fPタグを使用ã—ã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€å¿…è¦ãªå ´æ‰€ã«ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ã§ãƒªãƒ³ã‚¯ã‚’作æˆã§ãã¾ã™ã€‚次ã«ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl /** .fl * @deprecated As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)} .fl */ .fl .fl \fP .fi .TP 2 o Javadoc 1.1ã§ã¯ã€\f2@see\fPã‚¿ã‚°(インラインã¯ä¸å¯)ã‚’\f2@deprecated\fPã‚¿ã‚°ã”ã¨ã«ä½œæˆã™ã‚‹ã®ãŒæ¨™æº–ã®å½¢å¼ã§ã™ã€‚ .RE .LP 推奨ã•ã‚Œãªã„ã‚¿ã‚°ã®è©³ç´°ã¯ã€ .na \f2@deprecatedã‚¿ã‚°\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/deprecation/index.htmlã®ãƒ‰ã‚ュメントをå‚ç…§ã—ã¦ãã ã•ã„。 .LP .RS 3 .TP 3 {@code\ text} \f2<code>{@literal}</code>\fPã¨åŒç‰ã§ã™ã€‚ .LP テã‚ストをHTMLマークアップã¾ãŸã¯ãƒã‚¹ãƒˆã•ã‚ŒãŸjavadocã‚¿ã‚°ã¨ã—ã¦è§£é‡ˆã›ãšã«ã€\f2text\fPã‚’\f2コード\fP・フォントã§è¡¨ç¤ºã—ã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€ãƒ‰ã‚ュメンテーション・コメントã§ã¯ã€ãƒ‘ラメータã®åž‹(\f2<Object>\fP)ã€ä¸ç‰å·(\f23 < 4\fP)ã€çŸ¢å°(\f2<\-\fP)ãªã©ã§ã€é€šå¸¸ã®å±±æ‹¬å¼§(\f2<\fPãŠã‚ˆã³\f2>\fP)ã‚’HTMLエンティティ(\f2<\fPãŠã‚ˆã³\f2>\fP)ã®ã‹ã‚ã‚Šã«ä½¿ç”¨ã§ãã¾ã™ã€‚ãŸã¨ãˆã°ã€æ¬¡ã®ãƒ‰ã‚ュメンテーション・コメント .nf \f3 .fl \fP\f4{@code A<B>C}\fP\f3 .fl .fl \fP .fi .LP ã¯ã€ç”Ÿæˆã•ã‚ŒãŸHTMLページã§ã€æ¬¡ã®ã‚ˆã†ã«ãã®ã¾ã¾è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl \fP\f4A<B>C\fP\f3 .fl .fl \fP .fi .LP ã“ã“ã§æ³¨ç›®ã«å€¤ã™ã‚‹ã®ã¯ã€\f2<B>\fPãŒå¤ªå—ã¨ã—ã¦è§£é‡ˆã•ã‚Œãšã€ãã®ãƒ•ã‚©ãƒ³ãƒˆã¯ã‚³ãƒ¼ãƒ‰ãƒ»ãƒ•ã‚©ãƒ³ãƒˆã«ãªã‚‹ã€ã¨ã„ã†ç‚¹ã§ã™ã€‚ .LP コード・フォントãªã—ã§åŒã˜æ©Ÿèƒ½ã‚’実ç¾ã™ã‚‹ã«ã¯ã€\f2{@literal}\fPを使用ã—ã¾ã™ã€‚ .LP .TP 3 {@docRoot} 生æˆã•ã‚Œã‚‹ãƒšãƒ¼ã‚¸ã‹ã‚‰ã®ã€ç”Ÿæˆãƒ‰ã‚ュメントã®(生æˆå…ˆ)ルート・ディレクトリã¸ã®ç›¸å¯¾ãƒ‘スを表ã—ã¾ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€è‘—作権ã®ãƒšãƒ¼ã‚¸ã‚„会社ã®ãƒã‚´ãªã©ã€ç”Ÿæˆã•ã‚Œã‚‹ã™ã¹ã¦ã®ãƒšãƒ¼ã‚¸ã‹ã‚‰å‚ç…§ã™ã‚‹ãƒ•ã‚¡ã‚¤ãƒ«ã‚’組ã¿è¾¼ã‚€ã¨ãã«ä¾¿åˆ©ã§ã™ã€‚通常ã¯ã€å„ページã®æœ€ä¸‹éƒ¨ã‹ã‚‰è‘—作権ã®ãƒšãƒ¼ã‚¸ã«ãƒªãƒ³ã‚¯ã—ã¾ã™ã€‚ .LP ã“ã®\f2{@docRoot}\fPã‚¿ã‚°ã¯ã€ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã§ã‚‚ドã‚ュメンテーション・コメント内ã§ã‚‚使用ã§ãã¾ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€@returnã€@paramã€@deprecatedãªã©ã®ä»»æ„ã®ã‚¿ã‚°ã®ãƒ†ã‚スト部分をå«ã‚€ã€ã™ã¹ã¦ã®ãƒ‰ã‚ュメンテーション・コメントã€ã¤ã¾ã‚Šæ¦‚è¦ã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ãŠã‚ˆã³ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã§æœ‰åŠ¹ã§ã™ã€‚ .RS 3 .TP 3 1. コマンドラインã§ã¯ã€ãƒ˜ãƒƒãƒ€ãƒ¼ã€ãƒ•ãƒƒã‚¿ãƒ¼ã€ã¾ãŸã¯ãƒœãƒˆãƒ ã¯æ¬¡ã®ã‚ˆã†ã«å®šç¾©ã—ã¾ã™ã€‚ .nf \f3 .fl javadoc \-bottom '<a href="{@docRoot}/copyright.html">Copyright</a>' .fl .fl \fP .fi .LP æ³¨æ„ \- \f2{@docRoot}\fPã‚’Makefile内ã§ã“ã®ã‚ˆã†ã«åˆ©ç”¨ã™ã‚‹å ´åˆã€ä¸€éƒ¨ã®Makefileプãƒã‚°ãƒ©ãƒ ã§ã¯ã€ä¸æ‹¬å¼§{ }æ–‡å—を特別ã«ã‚¨ã‚¹ã‚±ãƒ¼ãƒ—ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ãŸã¨ãˆã°ã€Inprise MAKEãƒãƒ¼ã‚¸ãƒ§ãƒ³5.2ã‚’Windows上ã§å®Ÿè¡Œã™ã‚‹å ´åˆã¯ã€\f2{{@docRoot}}\fPã®ã‚ˆã†ã«ã€ä¸æ‹¬å¼§ã‚’二é‡ã«ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã•ã‚‰ã«ã€\f2\-bottom\fPãªã©ã®ã‚ªãƒ—ションã«å¯¾ã™ã‚‹å¼•æ•°ã‚’ã€ä¸€é‡å¼•ç”¨ç¬¦ã§ã¯ãªã二é‡å¼•ç”¨ç¬¦ã§å›²ã‚€å¿…è¦ã‚‚ã‚ã‚Šã¾ã™(\f2href\fP引数を囲む引用符ã¯çœç•¥)。 .TP 3 2. ドã‚ュメンテーション・コメントã®ä¸ã§ã¯ã€æ¬¡ã®ã‚ˆã†ã«ä½¿ç”¨ã—ã¾ã™ã€‚ .nf \f3 .fl /** .fl * See the <a href="{@docRoot}/copyright.html">Copyright</a>. .fl */ .fl .fl \fP .fi .RE .LP ã“ã®ã‚¿ã‚°ãŒå¿…è¦ãªç†ç”±ã¯ã€ç”Ÿæˆãƒ‰ã‚ュメントãŒã€ã‚µãƒ–パッケージã¨åŒã˜æ·±ã•ã‚’æŒã¤éšŽå±¤æ§‹é€ ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«æ ¼ç´ã•ã‚Œã‚‹ã‹ã‚‰ã§ã™ã€‚å¼ .nf \f3 .fl <a href="{@docRoot}/copyright.html"> .fl .fl \fP .fi .LP ã¯ã€æ¬¡ã®ã‚ˆã†ã«è§£æ±ºã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl <a href="../../copyright.html"> for java/lang/Object.java .fl .fl \fP .fi .LP ãŠã‚ˆã³ .nf \f3 .fl <a href="../../../copyright.html"> for java/lang/ref/Reference.java .fl .fl \fP .fi .LP .TP 3 @exception\ class\-name\ description \f2@exception\fPã‚¿ã‚°ã¯ã€\f2@throws\fPã¨åŒç¾©ã§ã™ã€‚ .LP .TP 3 {@inheritDoc}\ 最も近ã„継承å¯èƒ½ãªã‚¯ãƒ©ã‚¹ã¾ãŸã¯å®Ÿè£…å¯èƒ½ãªã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‹ã‚‰ã€ã“ã®ã‚¿ã‚°ã®ä½ç½®ã«ã‚ã‚‹ç¾åœ¨ã®ãƒ‰ã‚ュメンテーション・コメントã«ã€ãƒ‰ã‚ュメントを継承(コピー)ã—ã¾ã™ã€‚ã“ã®æ©Ÿèƒ½ã«ã‚ˆã‚Šã€ã‚ˆã‚Šæ±Žç”¨çš„ãªã‚³ãƒ¡ãƒ³ãƒˆã‚’継承ツリーã®ä¸Šä½ã«è¨˜è¿°ã—ã€ã‚³ãƒ”ーã—ãŸãƒ†ã‚ストを使用ã—ã¦è¨˜è¿°ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ .LP ã“ã®ã‚¿ã‚°ã¯ã€ãƒ‰ã‚ュメンテーション・コメントã®æ¬¡ã®ä½ç½®ã§ã®ã¿æœ‰åŠ¹ã§ã™ã€‚ .RS 3 .TP 2 o メソッドã®ä¸»èª¬æ˜Žãƒ–ãƒãƒƒã‚¯å†…。ã“ã®å ´åˆã€ä¸»èª¬æ˜Žã¯ã€ä¸Šä½éšŽå±¤ã®ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‹ã‚‰ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ .TP 2 o メソッドã®@returnã€@paramã€@throwsã‚¿ã‚°ã®ãƒ†ã‚スト引数内。ã“ã®å ´åˆã€ã‚¿ã‚°ãƒ»ãƒ†ã‚ストã¯ã€ä¸Šä½éšŽå±¤ã®å¯¾å¿œã™ã‚‹ã‚¿ã‚°ã‹ã‚‰ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ .RE .LP 継承階層ã§ã‚³ãƒ¡ãƒ³ãƒˆã‚’見ã¤ã‘る方法ã«é–¢ã™ã‚‹æ£ç¢ºãªèª¬æ˜Žã¯ã€ãƒ¡ã‚½ãƒƒãƒ‰ãƒ»ã‚³ãƒ¡ãƒ³ãƒˆã®è‡ªå‹•ã‚³ãƒ”ーをå‚ç…§ã—ã¦ãã ã•ã„。ã“ã®ã‚¿ã‚°ãŒè¦‹ã¤ã‹ã‚‰ãªã„å ´åˆã€ã‚³ãƒ¡ãƒ³ãƒˆã¯ã€ã“ã®é …ã§èª¬æ˜Žã™ã‚‹ãƒ«ãƒ¼ãƒ«ã«å¿œã˜ã¦ã€è‡ªå‹•çš„ã«ç¶™æ‰¿ã•ã‚Œã‚‹ã‹ã©ã†ã‹ãŒæ±ºã¾ã‚Šã¾ã™ã€‚ .LP .TP 3 {@link\ package.class#member\ label} 表示テã‚スト\f2label\fPã¨ã¨ã‚‚ã«ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ãƒªãƒ³ã‚¯ã‚’挿入ã—ã¾ã™ã€‚labelã¯ã€å‚照クラスã®æŒ‡å®šã•ã‚ŒãŸãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã¾ãŸã¯ãƒ¡ãƒ³ãƒãƒ¼ã®åå‰ã®ãƒ‰ã‚ュメントを指ã—示ã—ã¾ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€@returnã€@paramã€@deprecatedãªã©ã®ä»»æ„ã®ã‚¿ã‚°ã®ãƒ†ã‚スト部分をå«ã‚€ã€ã™ã¹ã¦ã®ãƒ‰ã‚ュメンテーション・コメントã€ã¤ã¾ã‚Šæ¦‚è¦ã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ãŠã‚ˆã³ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã§æœ‰åŠ¹ã§ã™ã€‚ .LP ã“ã®ã‚¿ã‚°ã¯\f2@see\fPã¨éžå¸¸ã«ã‚ˆãä¼¼ã¦ã„ã¾ã™ã€‚ã©ã¡ã‚‰ã‚‚ã€\f2package.class\fP\f2#\fP\f2member\fPã¨\f2label\fPã®å‚照方法ãŒåŒã˜ã§ã€æœ‰åŠ¹ãªæ§‹æ–‡ã‚‚ã¾ã£ãŸãåŒã˜ã§ã™ã€‚主ãªé•ã„ã¯ã€\f2{@link}\fPã§ã¯ã€ã€Œé–¢é€£é …ç›®ã€ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã«ãƒªãƒ³ã‚¯ãŒé…ç½®ã•ã‚Œã‚‹ã‹ã‚ã‚Šã«ã€ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ãƒªãƒ³ã‚¯ãŒç”Ÿæˆã•ã‚Œã‚‹ã¨ã„ã†ç‚¹ã§ã™ã€‚ã¾ãŸã€ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ãƒ†ã‚ストã®ä»–ã®éƒ¨åˆ†ã¨åŒºåˆ¥ã™ã‚‹ãŸã‚ã«ã€\f2{@link}\fPã‚¿ã‚°ã®æœ€åˆã¨æœ€å¾Œã«ä¸æ‹¬å¼§ã‚’記述ã—ã¾ã™ã€‚ラベルã®ä¸ã§ã€Œ}ã€ã‚’使用ã™ã‚‹å¿…è¦ãŒã‚ã‚‹å ´åˆã¯ã€HTMLエンティティ表記法ã®ã€Œ}ã€ã‚’使用ã—ã¾ã™ã€‚ .LP 1ã¤æ–‡ã®ä¸ã§ä½¿ç”¨ã§ãã‚‹\f2{@link}\fPã‚¿ã‚°ã®æ•°ã«åˆ¶é™ã¯ã‚ã‚Šã¾ã›ã‚“。ã“ã®ã‚¿ã‚°ã¯ã€ãƒ‰ã‚ュメンテーション・コメントã®ä¸»èª¬æ˜Žéƒ¨åˆ†ã€ã¾ãŸã¯@deprecatedã€@returnã€@paramãªã©ã®ä»»æ„ã®ã‚¿ã‚°ã®ãƒ†ã‚スト部分ã§ä½¿ç”¨ã§ãã¾ã™ã€‚ .LP ãŸã¨ãˆã°ã€æ¬¡ã®ã‚³ãƒ¡ãƒ³ãƒˆã§ã¯\f2getComponentAt(int,int)\fPメソッドをå‚ç…§ã—ã¦ã„ã¾ã™ã€‚ .nf \f3 .fl Use the {@link #getComponentAt(int, int) getComponentAt} method. .fl .fl \fP .fi .LP 標準ドックレットã§ã¯ã€ä¸Šã®ã‚³ãƒ¡ãƒ³ãƒˆã‹ã‚‰æ¬¡ã®HTMLãŒç”Ÿæˆã•ã‚Œã¾ã™(ã“ã®ã‚³ãƒ¡ãƒ³ãƒˆãŒåŒã˜ãƒ‘ッケージã®åˆ¥ã®ã‚¯ãƒ©ã‚¹ã‚’å‚ç…§ã—ã¦ã„ã‚‹å ´åˆ)。 .nf \f3 .fl Use the <a href="Component.html#getComponentAt(int, int)">getComponentAt</a> method. .fl .fl \fP .fi .LP ã“ã‚Œã¯ã€Webページ上ã§ã¯æ¬¡ã®ã‚ˆã†ã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl Use the getComponentAt method. .fl .fl \fP .fi .LP \f2{@link}\fPã‚’æ‹¡å¼µã—ã¦ãƒ‰ã‚ュメント化ã•ã‚Œãªã„クラスã«ãƒªãƒ³ã‚¯ã™ã‚‹ã«ã¯ã€\f2\-link\fPオプションを使用ã—ã¾ã™ã€‚ .LP 詳細ã¯ã€ .na \f2{@link}ã‚¿ã‚°ã®ãƒ‰ã‚ュメント\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#{@link}ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .LP .TP 3 {@linkplain\ package.class#member\ label} リンクã®ãƒ©ãƒ™ãƒ«ãŒã‚³ãƒ¼ãƒ‰ãƒ»ãƒ•ã‚©ãƒ³ãƒˆã§ã¯ãªãプレーン・テã‚ストã§è¡¨ç¤ºã•ã‚Œã‚‹ç‚¹ä»¥å¤–ã¯\f2{@link}\fPã¨åŒã˜ã§ã™ã€‚ラベルãŒãƒ—レーン・テã‚ストã§è¨˜è¿°ã•ã‚Œã¦ã„ã‚‹ã¨ä¾¿åˆ©ã§ã™ã€‚例: .nf \f3 .fl Refer to {@linkplain add() the overridden method}. .fl .fl \fP .fi .LP ã“ã‚Œã¯æ¬¡ã®ã‚ˆã†ã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .LP Refer to the overridden method. .LP .TP 3 {@literal\ text} テã‚ストをHTMLマークアップã¾ãŸã¯ãƒã‚¹ãƒˆã•ã‚ŒãŸjavadocã‚¿ã‚°ã¨ã—ã¦è§£é‡ˆã›ãšã«ã€\f2text\fPを表示ã—ã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€ãƒ‰ã‚ュメンテーション・コメントã§ã¯ã€ãƒ‘ラメータã®åž‹(\f2<Object>\fP)ã€ä¸ç‰å·(\f23 < 4\fP)ã€çŸ¢å°(\f2<\-\fP)ãªã©ã§ã€é€šå¸¸ã®å±±æ‹¬å¼§(\f2<\fPãŠã‚ˆã³\f2>\fP)ã‚’HTMLエンティティ(\f2<\fPãŠã‚ˆã³\f2>\fP)ã®ã‹ã‚ã‚Šã«ä½¿ç”¨ã§ãã¾ã™ã€‚ãŸã¨ãˆã°ã€æ¬¡ã®ãƒ‰ã‚ュメンテーション・コメント .nf \f3 .fl \fP\f4{@literal A<B>C}\fP\f3 .fl .fl \fP .fi .LP ã¯ã€ãƒ–ラウザã§ç”Ÿæˆã•ã‚ŒãŸHTMLページã«æ¬¡ã®ã‚ˆã†ã«ãã®ã¾ã¾è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .LP \f2\ \ \ \ \ \fPA<B>C .LP ã“ã“ã§æ³¨ç›®ã«å€¤ã™ã‚‹ã®ã¯ã€\f2<B>\fPãŒå¤ªå—ã¨ã—ã¦è§£é‡ˆã•ã‚Œãšã€ãã®ãƒ•ã‚©ãƒ³ãƒˆã¯ã‚³ãƒ¼ãƒ‰ãƒ»ãƒ•ã‚©ãƒ³ãƒˆã«ãªã‚‰ãªã„ã€ã¨ã„ã†ç‚¹ã§ã™ã€‚ .LP コード・フォントã§åŒã˜æ©Ÿèƒ½ã‚’実ç¾ã™ã‚‹ã«ã¯ã€\f2{@code}\fPを使用ã—ã¾ã™ã€‚ .LP .TP 3 @param\ parameter\-name description 「パラメータã€ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã«ã€æŒ‡å®šã•ã‚ŒãŸ\f2parameter\-name\fPã®å¾Œã«æŒ‡å®šã•ã‚ŒãŸ\f2description\fPを続ã‘ã¦ãƒ‘ãƒ©ãƒ¡ãƒ¼ã‚¿ã‚’è¿½åŠ ã—ã¾ã™ã€‚ドã‚ュメンテーション・コメントを記述ã™ã‚‹ã¨ãã«ã¯ã€\f2description\fPを複数行ã«ã‚ãŸã£ã¦è¨˜è¿°ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ã¾ãŸã¯ã‚¯ãƒ©ã‚¹ã®ãƒ‰ã‚ュメンテーション・コメント内ã§ã®ã¿æœ‰åŠ¹ã§ã™ã€‚ .LP \f2parameter\-name\fPã¯ã€ãƒ¡ã‚½ãƒƒãƒ‰ã¾ãŸã¯ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã§ã®ãƒ‘ラメータã®åå‰ã‹ã€ã‚¯ãƒ©ã‚¹ã€ãƒ¡ã‚½ãƒƒãƒ‰ã¾ãŸã¯ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã®åž‹ãƒ‘ラメータã®åå‰ã«ãªã‚Šã¾ã™ã€‚山括弧ã§ã“ã®ãƒ‘ラメータåを囲ã¿ã€åž‹ãƒ‘ラメータを使用ã™ã‚‹ã“ã¨ã‚’指定ã—ã¾ã™ã€‚ .LP クラスã®åž‹ãƒ‘ラメータã®ä¾‹: .nf \f3 .fl /** .fl * @param <E> Type of element stored in a list .fl */ .fl public interface List<E> extends Collection<E> { .fl } .fl .fl \fP .fi .LP メソッドã®åž‹ãƒ‘ラメータã®ä¾‹: .nf \f3 .fl /** .fl * @param string the string to be converted .fl * @param type the type to convert the string to .fl * @param <T> the type of the element .fl * @param <V> the value of the element .fl */ .fl <T, V extends T> V convert(String string, Class<T> type) { .fl } .fl .fl \fP .fi .LP 詳細ã¯ã€ .na \f2@paramã‚¿ã‚°ã®ãƒ‰ã‚ュメント\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@paramã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .LP .TP 3 @return\ description 「戻り値ã€ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã‚’è¿½åŠ ã—ã¦ã€\f2description\fPã®ãƒ†ã‚ストを書ãè¾¼ã¿ã¾ã™ã€‚ã“ã®ãƒ†ã‚ストã§ã¯ã€æˆ»ã‚Šå€¤ã®åž‹ã¨ã€å–り得る値ã®ç¯„囲ã«ã¤ã„ã¦è¨˜è¿°ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€ãƒ¡ã‚½ãƒƒãƒ‰ã®ãƒ‰ã‚ュメンテーション・コメントã§ã®ã¿æœ‰åŠ¹ã§ã™ã€‚ .LP 詳細ã¯ã€ .na \f2@returnã‚¿ã‚°ã®ãƒ‰ã‚ュメント\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@returnã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .LP .TP 3 @see\ reference ã€Œé–¢é€£é …ç›®ã€è¦‹å‡ºã—ã‚’è¿½åŠ ã—ã¦ã€\f2reference\fPを指ã™ãƒªãƒ³ã‚¯ã€ã¾ãŸã¯ãƒ†ã‚スト・エントリを書ãè¾¼ã¿ã¾ã™ã€‚1ã¤ã®ãƒ‰ã‚ュメンテーション・コメントã«ã¯ä»»æ„ã®æ•°ã®\f2@see\fPã‚¿ã‚°ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ãŒã€ãれらã¯ã™ã¹ã¦åŒã˜è¦‹å‡ºã—ã®ä¸‹ã«ã‚°ãƒ«ãƒ¼ãƒ—化ã•ã‚Œã¾ã™ã€‚\f2@see\fPã‚¿ã‚°ã«ã¯ã€æ¬¡ã®3ã¤ã®ã‚¿ã‚¤ãƒ—ã®å½¢å¼ãŒã‚ã‚Šã¾ã™ã€‚最もよã使用ã•ã‚Œã‚‹ã®ã¯ã€3番目ã®å½¢å¼ã§ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€ã™ã¹ã¦ã®ãƒ‰ã‚ュメンテーション・コメントã€ã¤ã¾ã‚Šæ¦‚è¦ã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã¾ãŸã¯ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã§æœ‰åŠ¹ã§ã™ã€‚パッケージã€ã‚¯ãƒ©ã‚¹ã€ã¾ãŸã¯ãƒ¡ãƒ³ãƒãƒ¼ã«å¯¾ã™ã‚‹ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ãƒªãƒ³ã‚¯ã‚’æ–‡ä¸ã«æŒ¿å…¥ã™ã‚‹æ–¹æ³•ã¯ã€\f2{@link}\fPã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .RS 3 .TP 3 @see "string" \f2string\fPã®ãƒ†ã‚ã‚¹ãƒˆãƒ»ã‚¨ãƒ³ãƒˆãƒªã‚’è¿½åŠ ã—ã¾ã™ã€‚リンクã¯ç”Ÿæˆã•ã‚Œã¾ã›ã‚“。\f2string\fPã¯ã€æ›¸ç±ã¾ãŸã¯URLã§ã¯ã‚¢ã‚¯ã‚»ã‚¹ã§ããªã„æƒ…å ±ã®å‚照先ã§ã™ã€‚Javadocツールã¯ã€æœ€åˆã®æ–‡å—ãŒäºŒé‡å¼•ç”¨ç¬¦(\f2"\fP)ã‹ã©ã†ã‹ã‚’調ã¹ã¦ã€ã“ã®å½¢å¼ã‚’å‰è¿°ã®å½¢å¼ã¨åŒºåˆ¥ã—ã¾ã™ã€‚次ã«ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl @see "The Java Programming Language" .fl .fl \fP .fi .LP ã“ã‚Œã¯æ¬¡ã®ã‚ˆã†ãªãƒ†ã‚ストを生æˆã—ã¾ã™ã€‚ .RE .RE .RS 3 .RS 3 .RS 3 .RS 3 .TP 3 é–¢é€£é …ç›®: "The Java Programming Language" .RE .RE .TP 3 @see <a href="URL#value">label</a> \f2URL\fP#\f2value\fPã§å®šç¾©ã•ã‚ŒãŸã¨ãŠã‚Šã«ãƒªãƒ³ã‚¯ã‚’è¿½åŠ ã—ã¾ã™ã€‚\f2URL\fP#\f2value\fPã¯ã€ç›¸å¯¾URLã¾ãŸã¯çµ¶å¯¾URLã§ã™ã€‚Javadocツールã¯ã€æœ€åˆã®æ–‡å—ãŒã€Œã‚ˆã‚Šå°ã•ã„ã€è¨˜å·(\f2<\fP)ã‹ã©ã†ã‹ã‚’調ã¹ã¦ã€ã“ã®å½¢å¼ã‚’ä»–ã®å½¢å¼ã¨åŒºåˆ¥ã—ã¾ã™ã€‚次ã«ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl @see <a href="spec.html#section">Java Spec</a> .fl \fP .fi ã“ã‚Œã¯æ¬¡ã®ã‚ˆã†ãªãƒªãƒ³ã‚¯ã‚’生æˆã—ã¾ã™ã€‚ .RS 3 .TP 3 é–¢é€£é …ç›®: Java Spec .RE .TP 3 @see\ package.class#member\ label 表示テã‚スト\f2label\fPã¨ã¨ã‚‚ã«ãƒªãƒ³ã‚¯ã‚’è¿½åŠ ã—ã¾ã™ã€‚ã“ã®ãƒªãƒ³ã‚¯ã¯ã€æŒ‡å®šã•ã‚ŒãŸåå‰ã‚’æŒã¤ã€å‚ç…§ã•ã‚Œã¦ã„ã‚‹Java言語ã®ãƒ¡ãƒ³ãƒãƒ¼ã®ãƒ‰ã‚ュメントを指ã—ã¾ã™ã€‚\f2label\fPã¯çœç•¥å¯èƒ½ã§ã™ã€‚labelã‚’çœç•¥ã™ã‚‹ã¨ã€åå‰ãŒã‹ã‚ã‚Šã«è¡¨ç¤ºãƒ†ã‚ストã¨ã—ã¦é©åˆ‡ã«çŸç¸®ã•ã‚Œã¦è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚åå‰ãŒè¡¨ç¤ºã•ã‚Œã‚‹æ–¹æ³•ã‚’å‚ç…§ã—ã¦ãã ã•ã„。\-noqualifierを使用ã™ã‚‹ã¨ã€ã“ã®è¡¨ç¤ºãƒ†ã‚ストã‹ã‚‰ãƒ‘ッケージåãŒå…¨ä½“çš„ã«å‰Šé™¤ã•ã‚Œã¾ã™ã€‚ラベルã¯ã€è‡ªå‹•ç”Ÿæˆã•ã‚Œã‚‹è¡¨ç¤ºãƒ†ã‚ストã¨ã¯ç•°ãªã‚‹è¡¨ç¤ºãƒ†ã‚ストã«ã™ã‚‹å ´åˆã«ä½¿ç”¨ã—ã¾ã™ã€‚ .LP ãƒãƒ¼ã‚¸ãƒ§ãƒ³1.2ã®ã¿ã¯ã€ãƒ©ãƒ™ãƒ«ã§ã¯ãªãã€åå‰ãŒ<code> HTMLタグ内ã«è‡ªå‹•çš„ã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚1.2.2ã‹ã‚‰ã¯ã€ãƒ©ãƒ™ãƒ«ã‚’使用ã™ã‚‹ã‹ã—ãªã„ã‹ã«ã‹ã‹ã‚らãšã€<code>ã¯å¸¸ã«è¡¨ç¤ºãƒ†ã‚ストを囲むã‹ãŸã¡ã§ã€å«ã¾ã‚Œã¾ã™ã€‚ .LP .RS 3 .TP 2 o \f4package.class\fP\f4#\fP\f4member\fPã«ã¯ã€å‚ç…§ã•ã‚Œã¦ã„ã‚‹ä»»æ„ã®æœ‰åŠ¹ãªãƒ—ãƒã‚°ãƒ©ãƒ è¦ç´ ã®åå‰ã‚’指定ã—ã¾ã™ã€‚ã¤ã¾ã‚Šã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã¾ãŸã¯ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®åå‰ã§ã™ã€‚ãŸã ã—ã€ãƒ¡ãƒ³ãƒãƒ¼åã®å‰ã®æ–‡å—ã¯ã€ã‚·ãƒ£ãƒ¼ãƒ—記å·(\f2#\fP)ã«ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\f2class\fPã¯ã€ä»»æ„ã®ãƒˆãƒƒãƒ—レベルã¾ãŸã¯ãƒã‚¹ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‚’表ã—ã¾ã™ã€‚\f2member\fPã¯ã€ä»»æ„ã®ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã¾ãŸã¯ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã‚’表ã—ã¾ã™(ãƒã‚¹ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã§ã¯ã‚ã‚Šã¾ã›ã‚“)。ã“ã®åå‰ãŒã€ãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ã«å«ã¾ã‚Œã¦ã„ã‚‹å ´åˆã€Javadocツールã¯ã€ãã®åå‰ã¸ã®ãƒªãƒ³ã‚¯ã‚’自動的ã«ä½œæˆã—ã¾ã™ã€‚外部å‚照クラスã¸ã®ãƒªãƒ³ã‚¯ã‚’作æˆã™ã‚‹ã«ã¯ã€\f2\-link\fPオプションを使用ã—ã¾ã™ã€‚å‚照クラスã«å±žã—ã¦ã„ãªã„åå‰ã®ãƒ‰ã‚ュメントをå‚ç…§ã™ã‚‹ã«ã¯ã€ä»–ã®2ã¤ã®\f2@see\fPå½¢å¼ã®ã©ã¡ã‚‰ã‹ã‚’使用ã—ã¾ã™ã€‚ã“ã®å¼•æ•°ã«ã¤ã„ã¦ã¯ã€å¾Œè¿°ã®åå‰ã®æŒ‡å®šã§è©³ã—ã説明ã—ã¾ã™ã€‚ .TP 2 o \f4label\fPã¯ã€çœç•¥å¯èƒ½ãªãƒ†ã‚ストã§ã€ãƒªãƒ³ã‚¯ã®ãƒ©ãƒ™ãƒ«ã¨ã—ã¦è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚\f2label\fPã«ã¯ç©ºç™½ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚\f2label\fPã‚’çœç•¥ã™ã‚‹ã¨ã€\f2package.class.member\fPãŒã€ç¾åœ¨ã®ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ãƒ‘ッケージã«å¿œã˜ã¦é©åˆ‡ã«çŸç¸®ã•ã‚Œã¦è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚åå‰ãŒè¡¨ç¤ºã•ã‚Œã‚‹æ–¹æ³•ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .TP 2 o 空白文å—ãŒã€\f2package.class\fP\f2#\fP\f2member\fPã¨\f2label\fPã®é–“ã®åŒºåˆ‡ã‚Šæ–‡å—ã«ãªã‚Šã¾ã™ã€‚括弧ã®å†…å´ã®ç©ºç™½æ–‡å—ã¯ãƒ©ãƒ™ãƒ«ã®å…ˆé ã¨ã¯è§£é‡ˆã•ã‚Œãªã„ãŸã‚ã€ãƒ¡ã‚½ãƒƒãƒ‰ã®ãƒ‘ラメータ間ã«ç©ºç™½æ–‡å—を入れã¦ã‚‚ã‹ã¾ã„ã¾ã›ã‚“。 .RE .LP \f3例\fP \- ã“ã®ä¾‹ã§ã¯ã€\f2@see\fPã‚¿ã‚°(\f2Character\fPクラス内)ãŒã€\f2String\fPクラスã®\f2equals\fPメソッドをå‚ç…§ã—ã¦ã„ã¾ã™ã€‚ã‚¿ã‚°ã«ã¯ã€åå‰ã€Œ\f2String#equals(Object)\fPã€ã¨ãƒ©ãƒ™ãƒ«ã€Œ\f2equals\fPã€ã®ä¸¡æ–¹ã®å¼•æ•°ãŒå«ã¾ã‚Œã¦ã„ã¾ã™ã€‚ .nf \f3 .fl /** .fl * @see String#equals(Object) equals .fl */ .fl \fP .fi 標準ドックレットã¯ã€æ¬¡ã®ã‚ˆã†ãªHTMLを生æˆã—ã¾ã™ã€‚ .nf \f3 .fl <dl> .fl <dt><b>See Also:</b> .fl <dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals<code></a> .fl </dl> .fl \fP .fi ã“ã‚Œã¯ã€ãƒ–ラウザã§ã¯æ¬¡ã®ã‚ˆã†ã«è¡¨ç¤ºã•ã‚Œã€ãƒ©ãƒ™ãƒ«ãŒè¡¨ç¤ºãƒªãƒ³ã‚¯ãƒ»ãƒ†ã‚ストã«ãªã‚Šã¾ã™ã€‚ .RS 3 .TP 3 é–¢é€£é …ç›®: equals .RE .LP \f3åå‰ã®æŒ‡å®š\fP \- ã“ã®\f2package.class\fP\f2#\fP\f2member\fPã¨ã„ã†åå‰ã¯ã€\f2java.lang.String#toUpperCase()\fPã®ã‚ˆã†ãªå®Œå…¨ä¿®é£¾åã«ã™ã‚‹ã“ã¨ã‚‚ã€\f2String#toUpperCase()\fPã‚„\f2#toUpperCase()\fPã®ã‚ˆã†ãªéžå®Œå…¨ä¿®é£¾åã«ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚åå‰ãŒå®Œå…¨ã«ã¯ä¿®é£¾ã•ã‚Œã¦ã„ãªã„å ´åˆã€Javadocツールã¯ã€Javaコンパイラã®é€šå¸¸ã®æ¤œç´¢é †åºã§ãã®åå‰ã‚’検索ã—ã¾ã™ã€‚詳細ã¯ã€å¾Œè¿°ã®@seeã®æ¤œç´¢é †åºã‚’å‚ç…§ã—ã¦ãã ã•ã„。åå‰ã«ã¯ã€ãƒ¡ã‚½ãƒƒãƒ‰ã®è¤‡æ•°ã®å¼•æ•°ã®é–“ãªã©ã€æ‹¬å¼§ã®å†…å´ã§ã‚ã‚Œã°ç©ºç™½ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ .LP 「部分的ã«ä¿®é£¾ã€ã—ãŸçŸã„åå‰ã‚’指定ã™ã‚‹ã“ã¨ã®åˆ©ç‚¹ã¯ã€å…¥åŠ›ã™ã‚‹æ–‡å—æ•°ãŒæ¸›ã‚‹ã“ã¨ã‚„ã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ãŒèªã¿ã‚„ã™ããªã‚‹ã“ã¨ã§ã™ã€‚次ã®è¡¨ã«ã€æ§˜ã€…ãªå½¢å¼ã®åå‰ã‚’示ã—ã¾ã™ã€‚ã“ã“ã§ã€\f2Class\fPã«ã¯ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‚’ã€\f2Type\fPã«ã¯ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€é…列ã€ã¾ãŸã¯ãƒ—リミティブをã€\f2method\fPã«ã¯ãƒ¡ã‚½ãƒƒãƒ‰ã¾ãŸã¯ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã‚’ã€ãã‚Œãžã‚ŒæŒ‡å®šã§ãã¾ã™ã€‚ .LP .LP .TS .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 .de 35 .ps \n(.s .vs \n(.vu .in \n(.iu .if \n(.u .fi .if \n(.j .ad .if \n(.j=0 .na .. .nf .nr #~ 0 .if n .nr #~ 0.6n .ds #d .d .if \(ts\n(.z\(ts\(ts .ds #d nl .fc .nr 33 \n(.s .rm 80 .nr 34 \n(.lu .eo .am 80 .br .di a+ .35 .ft \n(.f .ll \n(34u*1u/2u .if \n(.l<\n(80 .ll \n(80u .in 0 \f4@see\fP\f3\ \fP\f4package.class#member\fP\f3ã®ä¸€èˆ¬çš„ãªå½¢å¼\fP .br .di .nr a| \n(dn .nr a- \n(dl .. .ec \ .eo .am 80 .br .di b+ .35 .ft \n(.f .ll \n(34u*1u/2u .if \n(.l<\n(80 .ll \n(80u .in 0 \f3ç¾åœ¨ã®ã‚¯ãƒ©ã‚¹ã®ãƒ¡ãƒ³ãƒãƒ¼ã‚’å‚ç…§ã™ã‚‹\ \ \ \ \ \ \fP .br \f2@see\fP\ \f2#\fP\f2field\fP .br \f2@see\fP\ \f2#\fP\f2method(Type,\ Type,...)\fP .br \f2@see\fP\ \f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP .br \f2@see\fP\ \f2#\fP\f2constructor(Type,\ Type,...)\fP .br \f2@see\fP\ \f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP .br .di .nr b| \n(dn .nr b- \n(dl .. .ec \ .eo .am 80 .br .di c+ .35 .ft \n(.f .ll \n(34u*1u/2u .if \n(.l<\n(80 .ll \n(80u .in 0 \f3ç¾åœ¨ã®ã€ã¾ãŸã¯ã‚¤ãƒ³ãƒãƒ¼ãƒˆã•ã‚ŒãŸãƒ‘ッケージã®åˆ¥ã®ã‚¯ãƒ©ã‚¹ã‚’å‚ç…§ã™ã‚‹\ \ \ \ \ \ \ \ \fP .br \f2@see\fP\ \f2Class\fP\f2#\fP\f2field\fP .br \f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP .br \f2@see\fP\ \f2Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP .br \f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP .br \f2@see\fP\ \f2Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP .br \f2@see\fP\ \f2Class.NestedClass\fP .br \f2@see\fP\ \f2Class\fP .br .di .nr c| \n(dn .nr c- \n(dl .. .ec \ .eo .am 80 .br .di d+ .35 .ft \n(.f .ll \n(34u*1u/2u .if \n(.l<\n(80 .ll \n(80u .in 0 \f3別ã®ãƒ‘ッケージã®è¦ç´ ã‚’å‚ç…§ã™ã‚‹\fP\ (完全修飾)\ \ \ \ .br \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2field\fP .br \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type,\ Type,...)\fP .br \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2method(Type\ argname,\ Type\ argname,...)\fP .br \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type,\ Type,...)\fP .br \f2@see\fP\ \f2package.Class\fP\f2#\fP\f2constructor(Type\ argname,\ Type\ argname,...)\fP .br \f2@see\fP\ \f2package.Class.NestedClass\fP .br \f2@see\fP\ \f2package.Class\fP .br \f2@see\fP\ \f2package\fP .br .di .nr d| \n(dn .nr d- \n(dl .. .ec \ .35 .nf .ll \n(34u .nr 80 0 .80 .rm 80 .nr 38 \n(a- .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \n(b- .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \n(c- .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \n(d- .if \n(80<\n(38 .nr 80 \n(38 .35 .nf .ll \n(34u .nr 38 1n .nr 79 0 .nr 40 \n(79+(0*\n(38) .nr 80 +\n(40 .nr TW \n(80 .if t .if \n(TW>\n(.li .tm Table at line 1352 file Input is too wide - \n(TW units .fc .nr #T 0-1 .nr #a 0-1 .eo .de T# .ds #d .d .if \(ts\n(.z\(ts\(ts .ds #d nl .mk ## .nr ## -1v .ls 1 .ls .. .ec .ne \n(a|u+\n(.Vu .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) .ta \n(80u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u' .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(40u .in +\n(37u .a+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .ne \n(b|u+\n(.Vu .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) .ta \n(80u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u' .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(40u .in +\n(37u .b+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .ne \n(c|u+\n(.Vu .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) .ta \n(80u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u' .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(40u .in +\n(37u .c+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .ne \n(d|u+\n(.Vu .if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) .ta \n(80u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u' .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(40u .in +\n(37u .d+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .fc .nr T. 1 .T# 1 .35 .rm a+ .rm b+ .rm c+ .rm d+ .TE .if \n-(b.=0 .nr c. \n(.c-\n(d.-58 .LP 上ã®è¡¨ã«å¯¾ã™ã‚‹è£œè¶³äº‹é …を次ã«ç¤ºã—ã¾ã™ã€‚ .RS 3 .TP 2 o 最åˆã®ã‚¿ã‚¤ãƒ—ã®å½¢å¼(パッケージã¨ã‚¯ãƒ©ã‚¹ã‚’çœç•¥)ã®å ´åˆã€Javadocツールã¯ã€ç¾åœ¨ã®ã‚¯ãƒ©ã‚¹ã®éšŽå±¤ã®ã¿ã‚’検索ã—ã¾ã™ã€‚ã¤ã¾ã‚Šã€ç¾åœ¨ã®ã‚¯ãƒ©ã‚¹ã‹ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ãã®ã‚¹ãƒ¼ãƒ‘ークラスã‹ã‚¹ãƒ¼ãƒ‘ーインタフェースã€ã¾ãŸã¯ãã®å¤–å´ã‚’囲んã§ã„るクラスã‹ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‹ã‚‰ãƒ¡ãƒ³ãƒãƒ¼ã‚’検索ã—ã¾ã™(æ¤œç´¢æ‰‹é †1\-3)。ç¾åœ¨ã®ãƒ‘ッケージã®ä»–ã®éƒ¨åˆ†ã‚„ã€ä»–ã®ãƒ‘ッケージã¯æ¤œç´¢ã—ã¾ã›ã‚“(æ¤œç´¢æ‰‹é †4\-5)。 .TP 2 o メソッドã¾ãŸã¯ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã®å…¥åŠ›æ™‚ã«ã€\f2getValue\fPã®ã‚ˆã†ã«æ‹¬å¼§ãªã—ã®åå‰ã‚’使用ã—ãŸå ´åˆã€åŒã˜åå‰ã®ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ãŒå˜åœ¨ã—ã¦ã„ãªã‘ã‚Œã°ã€Javadocツールã¯ãã®åå‰ã¸ã®ãƒªãƒ³ã‚¯ã‚’æ£ã—ã作æˆã—ã¾ã™ãŒã€æ‹¬å¼§ã¨å¼•æ•°ã®è¿½åŠ を促ã™è¦å‘Šãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ã‚’出力ã—ã¾ã™ã€‚ã“ã®ãƒ¡ã‚½ãƒƒãƒ‰ãŒã‚ªãƒ¼ãƒãƒ¼ãƒãƒ¼ãƒ‰ã•ã‚Œã¦ã„ã‚‹å ´åˆã€Javadocツールã¯ã€æ¤œç´¢ã§æœ€åˆã«è¦‹ã¤ã‹ã£ãŸãƒ¡ã‚½ãƒƒãƒ‰ã«ãƒªãƒ³ã‚¯ã—ã¾ã™ã€‚çµæžœã¯å‰ã‚‚ã£ã¦ç‰¹å®šã§ãã¾ã›ã‚“。 .TP 2 o ãƒã‚¹ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã¯ã€ã™ã¹ã¦ã®å½¢å¼ã«ã¤ã„ã¦ã€\f2outer\fP\f2.\fP\f2inner\fPã¨ã—ã¦æŒ‡å®šã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚å˜ç´”ã«\f2inner\fPã¨ã¯ã—ãªã„ã§ãã ã•ã„。 .TP 2 o ã™ã§ã«è¿°ã¹ãŸã‚ˆã†ã«ã€ã‚¯ãƒ©ã‚¹ã¨ãƒ¡ãƒ³ãƒãƒ¼ã¨ã®é–“ã®åŒºåˆ‡ã‚Šæ–‡å—ã¨ã—ã¦ã¯ã€ãƒ‰ãƒƒãƒˆ(\f2.\fP)ã§ã¯ãªãシャープ文å—(\f2#\fP)を使用ã—ã¾ã™ã€‚ã“ã®ã‚ˆã†ã«æŒ‡å®šã™ã‚‹ã¨ã€Javadocツールã¯ã€ã‚ã„ã¾ã„ã•ã‚’解決ã§ãã¾ã™ã€‚ドットã¯ã€ã‚¯ãƒ©ã‚¹ã€ãƒã‚¹ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã€ãƒ‘ッケージã€ãŠã‚ˆã³ã‚µãƒ–パッケージを区切るãŸã‚ã«ã‚‚使用ã•ã‚Œã‚‹ã‹ã‚‰ã§ã™ã€‚ãŸã ã—ã€Javadocツールã§ã¯ä¸€èˆ¬ã«è¨±å®¹ç¯„囲ãŒåºƒãã€ã‚ã„ã¾ã„ã•ãŒãªã‘ã‚Œã°ãƒ‰ãƒƒãƒˆã¯æ£ã—ã解æžã•ã‚Œã¾ã™ã€‚ãã®å ´åˆã§ã‚‚ã€è¦å‘Šã¯è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .RE .LP \f3@seeã®æ¤œç´¢é †åº\fP \- Javadocツールã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«(.java)ã€ãƒ‘ッケージ・ファイル(package.htmlã¾ãŸã¯package\-info.java)ã¾ãŸã¯æ¦‚è¦ãƒ•ã‚¡ã‚¤ãƒ«(overview.html)ã«å«ã¾ã‚Œã‚‹\f2@see\fPタグを処ç†ã—ã¾ã™ã€‚後者ã®2ã¤ã®ãƒ•ã‚¡ã‚¤ãƒ«ã§ã¯ã€å®Œå…¨ä¿®é£¾ã®åå‰ã‚’\f2@see\fPã«æŒ‡å®šã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ソース・ファイルã§ã¯ã€å®Œå…¨ä¿®é£¾ã®åå‰ã€ã¾ãŸã¯éƒ¨åˆ†ä¿®é£¾ã®åå‰ã‚’指定ã§ãã¾ã™ã€‚ .LP Javadocツールã¯ã€å®Œå…¨ä¿®é£¾\f2ã§ãªã„\fPåå‰ãŒè¨˜è¿°ã•ã‚ŒãŸ\f2@see\fPã‚¿ã‚°ã‚’\f2.java\fPファイル内ã§è¦‹ã¤ã‘ã‚‹ã¨ã€Javaコンパイラã¨åŒã˜é †åºã§æŒ‡å®šã•ã‚ŒãŸåå‰ã‚’検索ã—ã¾ã™(ãŸã ã—ã€Javadocツールã¯ã€ç‰¹å®šã®åå‰ç©ºé–“ã®ã‚ã„ã¾ã„ã•ã‚’検出ã—ã¾ã›ã‚“。ã“ã‚Œã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã«ã“れらã®ã‚¨ãƒ©ãƒ¼ãŒå˜åœ¨ã—ã¦ã„ãªã„ã“ã¨ã‚’å‰æã¨ã—ã¦ã„ã‚‹ãŸã‚ã§ã™)。ã“ã®æ¤œç´¢é †åºã¯ã€\f2Java言語仕様\fPã§æ£å¼ã«å®šç¾©ã•ã‚Œã¦ã„ã¾ã™ã€‚Javadocツールã¯ã€é–¢é€£ã™ã‚‹ã‚¯ãƒ©ã‚¹ã¨ãƒ‘ッケージã€ãŠã‚ˆã³ã‚¤ãƒ³ãƒãƒ¼ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã¨ãƒ‘ッケージã®ã™ã¹ã¦ã‹ã‚‰ãã®åå‰ã‚’検索ã—ã¾ã™ã€‚具体的ã«ã¯ã€æ¬¡ã®é †åºã§æ¤œç´¢ã—ã¾ã™ã€‚ .RS 3 .TP 3 1. ç¾åœ¨ã®ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ .TP 3 2. 外å´ã‚’囲んã§ã„るクラスã¨ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹(最も近ã„ã‚‚ã®ã‹ã‚‰æ¤œç´¢) .TP 3 3. スーパークラスã¨ã‚¹ãƒ¼ãƒ‘ーインタフェース(最も近ã„ã‚‚ã®ã‹ã‚‰æ¤œç´¢) .TP 3 4. ç¾åœ¨ã®ãƒ‘ッケージ .TP 3 5. インãƒãƒ¼ãƒˆã•ã‚Œã¦ã„るパッケージã€ã‚¯ãƒ©ã‚¹ã€ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹(importæ–‡ã®é †åºã«å¾“ã£ã¦æ¤œç´¢) .RE .LP Javadocツールã¯ã€å„クラスã«ã¤ã„ã¦æ‰‹é †1\-3ã‚’å†å¸°çš„ã«é©ç”¨ã—ãªãŒã‚‰ã€ä¸€è‡´ã™ã‚‹åå‰ãŒè¦‹ã¤ã‹ã‚‹ã¾ã§æ¤œç´¢ã‚’続ã‘ã¾ã™ã€‚ã¤ã¾ã‚Šã€ã¾ãšç¾åœ¨ã®ã‚¯ãƒ©ã‚¹ã‚’検索ã—ã€æ¬¡ã«ãã®å¤–å´ã‚’囲んã§ã„るクラスEを検索ã—ãŸå¾Œã€Eã®ã‚¹ãƒ¼ãƒ‘ークラスを検索ã—ã¦ã‹ã‚‰ã€Eを囲んã§ã„るクラスを検索ã—ã¾ã™ã€‚ æ‰‹é †4ã¨5ã§ã¯ã€1ã¤ã®ãƒ‘ッケージ内ã®ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã‚’検索ã™ã‚‹é †åºã¯æ±ºã¾ã£ã¦ã„ã¾ã›ã‚“(ãã®é †åºã¯ã€å€‹ã€…ã®ã‚³ãƒ³ãƒ‘イラã«ã‚ˆã£ã¦ç•°ãªã‚Šã¾ã™)ã€‚æ‰‹é †5ã§ã¯ã€Javadocツールã¯ã€java.langを検索ã—ã¾ã™ã€‚ã“ã®ãƒ‘ッケージã¯ã€ã™ã¹ã¦ã®ãƒ—ãƒã‚°ãƒ©ãƒ ã«è‡ªå‹•çš„ã«ã‚¤ãƒ³ãƒãƒ¼ãƒˆã•ã‚Œã‚‹ã‹ã‚‰ã§ã™ã€‚ .LP Javadocツールã¯ã€å¿…ãšã—もサブクラスを検索ã™ã‚‹ã¨ã¯é™ã‚Šã¾ã›ã‚“。ã¾ãŸã€Javadocã®å®Ÿè¡Œä¸ã«ä»–ã®ãƒ‘ッケージã®ãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã‚‹å ´åˆã§ã‚‚ã€ä»–ã®ãƒ‘ッケージを検索ã—ã¾ã›ã‚“。ãŸã¨ãˆã°ã€\f2@see\fPã‚¿ã‚°ãŒ\f2java.awt.event.KeyEvent\fPクラス内ã«å«ã¾ã‚Œã¦ã„ã¦ã€\f2java.awt\fPパッケージ内ã®ã‚ã‚‹åå‰ã‚’å‚ç…§ã—ã¦ã„ã¦ã‚‚ã€ãã®ã‚¯ãƒ©ã‚¹ãŒã‚¤ãƒ³ãƒãƒ¼ãƒˆã—ãªã„ã‹ãŽã‚ŠJavadocã¯ãã®ãƒ‘ッケージを検索ã—ã¾ã›ã‚“。 .LP \f3åå‰ãŒè¡¨ç¤ºã•ã‚Œã‚‹æ–¹æ³•\fP \- \f2label\fPã‚’çœç•¥ã™ã‚‹ã¨ã€\f2package.class.member\fPãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚一般ã«ã€ã“ã‚Œã¯ç¾åœ¨ã®ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ãƒ‘ッケージã«å¿œã˜ã¦é©åˆ‡ã«çŸç¸®ã•ã‚Œã¾ã™ã€‚「çŸç¸®ã•ã‚Œã‚‹ã€ã¨ã¯ã€å¿…è¦æœ€å°é™ã®åå‰ã®ã¿ãŒè¡¨ç¤ºã•ã‚Œã‚‹ã¨ã„ã†ã“ã¨ã§ã™ã€‚ãŸã¨ãˆã°ã€\f2String.toUpperCase()\fPメソッドã«ã€åŒã˜ã‚¯ãƒ©ã‚¹ã®ãƒ¡ãƒ³ãƒãƒ¼ã¸ã®å‚ç…§ã¨ä»–ã®ã‚¯ãƒ©ã‚¹ã®ãƒ¡ãƒ³ãƒãƒ¼ã¸ã®å‚ç…§ãŒå«ã¾ã‚Œã¦ã„ã‚‹å ´åˆã€ã‚¯ãƒ©ã‚¹åãŒè¡¨ç¤ºã•ã‚Œã‚‹ã®ã¯å¾Œè€…ã®ã‚±ãƒ¼ã‚¹ã®ã¿ã§ã™(次ã®è¡¨ã‚’å‚ç…§)。 .LP パッケージåを全体的ã«å‰Šé™¤ã™ã‚‹ã«ã¯ã€\-noqualifierを使用ã—ã¾ã™ã€‚ .br .LP .TS .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 .de 35 .ps \n(.s .vs \n(.vu .in \n(.iu .if \n(.u .fi .if \n(.j .ad .if \n(.j=0 .na .. .nf .nr #~ 0 .if n .nr #~ 0.6n .ds #d .d .if \(ts\n(.z\(ts\(ts .ds #d nl .fc .nr 33 \n(.s .rm 80 81 82 .nr 34 \n(.lu .eo .am 81 .br .di a+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(81 .ll \n(81u .in 0 \f4String.toUpperCase()\fP\f3ã§ã®ä¾‹\fP .br .di .nr a| \n(dn .nr a- \n(dl .. .ec \ .eo .am 80 .br .di b+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(80 .ll \n(80u .in 0 \f2@see\fPã‚¿ã‚°ãŒåŒã˜ã‚¯ãƒ©ã‚¹ã€åŒã˜ãƒ‘ッケージã®ãƒ¡ãƒ³ãƒãƒ¼ã‚’å‚ç…§ã—ã¦ã„ã‚‹ .br .di .nr b| \n(dn .nr b- \n(dl .. .ec \ .eo .am 82 .br .di c+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(82 .ll \n(82u .in 0 \f2toLowerCase()\fP(パッケージåã¨ã‚¯ãƒ©ã‚¹åã¯çœç•¥) .br .di .nr c| \n(dn .nr c- \n(dl .. .ec \ .eo .am 80 .br .di d+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(80 .ll \n(80u .in 0 \f2@see\fPã‚¿ã‚°ãŒç•°ãªã‚‹ã‚¯ãƒ©ã‚¹ã€åŒã˜ãƒ‘ッケージã®ãƒ¡ãƒ³ãƒãƒ¼ã‚’å‚ç…§ã—ã¦ã„ã‚‹ .br .di .nr d| \n(dn .nr d- \n(dl .. .ec \ .eo .am 81 .br .di e+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(81 .ll \n(81u .in 0 \f2@see Character#toLowerCase(char)\fP .br .di .nr e| \n(dn .nr e- \n(dl .. .ec \ .eo .am 82 .br .di f+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(82 .ll \n(82u .in 0 \f2Character.toLowerCase(char)\fP(パッケージåã¯çœç•¥ã—ã€ã‚¯ãƒ©ã‚¹åã‚’å«ã‚€) .br .di .nr f| \n(dn .nr f- \n(dl .. .ec \ .eo .am 80 .br .di g+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(80 .ll \n(80u .in 0 \f2@see\fPã‚¿ã‚°ãŒç•°ãªã‚‹ã‚¯ãƒ©ã‚¹ã€ç•°ãªã‚‹ãƒ‘ッケージã®ãƒ¡ãƒ³ãƒãƒ¼ã‚’å‚ç…§ã—ã¦ã„ã‚‹ .br .di .nr g| \n(dn .nr g- \n(dl .. .ec \ .eo .am 81 .br .di h+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(81 .ll \n(81u .in 0 \f2@see java.io.File#exists()\fP .br .di .nr h| \n(dn .nr h- \n(dl .. .ec \ .eo .am 82 .br .di i+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(82 .ll \n(82u .in 0 \f2java.io.File.exists()\fP(パッケージåã¨ã‚¯ãƒ©ã‚¹åã‚’å«ã‚€) .br .di .nr i| \n(dn .nr i- \n(dl .. .ec \ .35 .nf .ll \n(34u .nr 80 0 .nr 38 \w\f3å‚ç…§ã®ã‚¿ã‚¤ãƒ—\fP .if \n(80<\n(38 .nr 80 \n(38 .80 .rm 80 .nr 38 \n(b- .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \n(d- .if \n(80<\n(38 .nr 80 \n(38 .nr 38 \n(g- .if \n(80<\n(38 .nr 80 \n(38 .nr 81 0 .nr 38 \w\f2@see String#toLowerCase()\fP .if \n(81<\n(38 .nr 81 \n(38 .81 .rm 81 .nr 38 \n(a- .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \n(e- .if \n(81<\n(38 .nr 81 \n(38 .nr 38 \n(h- .if \n(81<\n(38 .nr 81 \n(38 .nr 82 0 .nr 38 \w\f3表示ã•ã‚Œã‚‹åå‰\fP .if \n(82<\n(38 .nr 82 \n(38 .82 .rm 82 .nr 38 \n(c- .if \n(82<\n(38 .nr 82 \n(38 .nr 38 \n(f- .if \n(82<\n(38 .nr 82 \n(38 .nr 38 \n(i- .if \n(82<\n(38 .nr 82 \n(38 .35 .nf .ll \n(34u .nr 38 1n .nr 79 0 .nr 40 \n(79+(0*\n(38) .nr 80 +\n(40 .nr 41 \n(80+(3*\n(38) .nr 81 +\n(41 .nr 42 \n(81+(3*\n(38) .nr 82 +\n(42 .nr TW \n(82 .if t .if \n(TW>\n(.li .tm Table at line 1428 file Input is too wide - \n(TW units .fc .nr #T 0-1 .nr #a 0-1 .eo .de T# .ds #d .d .if \(ts\n(.z\(ts\(ts .ds #d nl .mk ## .nr ## -1v .ls 1 .ls .. .ec .ne \n(a|u+\n(.Vu .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) .ta \n(80u \n(81u \n(82u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\f3å‚ç…§ã®ã‚¿ã‚¤ãƒ—\fP\h'|\n(41u'\h'|\n(42u'\f3表示ã•ã‚Œã‚‹åå‰\fP .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(41u .in +\n(37u .a+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .ne \n(b|u+\n(.Vu .ne \n(c|u+\n(.Vu .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) .ta \n(80u \n(81u \n(82u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\h'|\n(41u'\f2@see String#toLowerCase()\fP\h'|\n(42u' .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(40u .in +\n(37u .b+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(##u-1v .nr 37 \n(42u .in +\n(37u .c+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .ne \n(d|u+\n(.Vu .ne \n(e|u+\n(.Vu .ne \n(f|u+\n(.Vu .if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v) .if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v) .if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v) .ta \n(80u \n(81u \n(82u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(40u .in +\n(37u .d+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(##u-1v .nr 37 \n(41u .in +\n(37u .e+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(##u-1v .nr 37 \n(42u .in +\n(37u .f+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .ne \n(g|u+\n(.Vu .ne \n(h|u+\n(.Vu .ne \n(i|u+\n(.Vu .if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v) .if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v) .if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v) .ta \n(80u \n(81u \n(82u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(40u .in +\n(37u .g+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(##u-1v .nr 37 \n(41u .in +\n(37u .h+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(##u-1v .nr 37 \n(42u .in +\n(37u .i+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .fc .nr T. 1 .T# 1 .35 .rm a+ .rm b+ .rm c+ .rm d+ .rm e+ .rm f+ .rm g+ .rm h+ .rm i+ .TE .if \n-(b.=0 .nr c. \n(.c-\n(d.-28 .LP \f3@seeã®ä¾‹\fP .br å³å´ã®ã‚³ãƒ¡ãƒ³ãƒˆã¯ã€\f2@see\fPã‚¿ã‚°ãŒ\f2java.applet.Applet\fPãªã©ã®åˆ¥ã®ãƒ‘ッケージã®ã‚¯ãƒ©ã‚¹å†…ã«ã‚ã‚‹å ´åˆã«ã€åå‰ãŒã©ã®ã‚ˆã†ã«è¡¨ç¤ºã•ã‚Œã‚‹ã‹ã‚’示ã—ã¦ã„ã¾ã™ã€‚ .nf \f3 .fl See also: .fl @see java.lang.String // String \fP\f3 .fl @see java.lang.String The String class // The String class \fP\f3 .fl @see String // String \fP\f3 .fl @see String#equals(Object) // String.equals(Object) \fP\f3 .fl @see String#equals // String.equals(java.lang.Object) \fP\f3 .fl @see java.lang.Object#wait(long) // java.lang.Object.wait(long) \fP\f3 .fl @see Character#MAX_RADIX // Character.MAX_RADIX \fP\f3 .fl @see <a href="spec.html">Java Spec</a> // Java Spec \fP\f3 .fl @see "The Java Programming Language" // "The Java Programming Language" \fP\f3 .fl \fP .fi \f2@see\fPã‚’æ‹¡å¼µã—ã¦ãƒ‰ã‚ュメント化ã•ã‚Œãªã„クラスã«ãƒªãƒ³ã‚¯ã™ã‚‹ã«ã¯ã€\f2\-link\fPオプションを使用ã—ã¾ã™ã€‚ .LP 詳細ã¯ã€ .na \f2@seeã‚¿ã‚°ã®ãƒ‰ã‚ュメント\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@seeã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .RE .RE .LP .RS 3 .TP 3 @serial\ field\-description | include | exclude デフォルトã®ç›´åˆ—化å¯èƒ½ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®ãƒ‰ã‚ュメンテーション・コメントã§ä½¿ç”¨ã—ã¾ã™ã€‚ .LP \f2field\-description\fP(çœç•¥å¯èƒ½)ã§ã¯ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®æ„味を説明ã—ã€å–り得る値ã®ãƒªã‚¹ãƒˆã‚’示ã™å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚å¿…è¦ã«å¿œã˜ã¦ã€è¤‡æ•°ã®è¡Œã«æ¸¡ã£ã¦èª¬æ˜Žã‚’記述ã§ãã¾ã™ã€‚標準ドックレットã¯ã€ã“ã®æƒ…å ±ã‚’ã€ç›´åˆ—化ã•ã‚ŒãŸå½¢å¼ãƒšãƒ¼ã‚¸ã«è¿½åŠ ã—ã¾ã™ã€‚ .LP クラスを直列化ã—ãŸå¾Œã—ã°ã‚‰ãã—ã¦ã‹ã‚‰ç›´åˆ—化å¯èƒ½ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã‚’クラスã«è¿½åŠ ã—ãŸå ´åˆã€ä¸»èª¬æ˜Žã«ã€è¿½åŠ ã—ãŸãƒãƒ¼ã‚¸ãƒ§ãƒ³ã‚’è˜åˆ¥ã™ã‚‹æ–‡ã‚’è¿½åŠ ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .LP \f2include\fPãŠã‚ˆã³\f2exclude\fP引数ã¯ã€ç›´åˆ—化ã•ã‚ŒãŸå½¢å¼ãƒšãƒ¼ã‚¸ã«ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ãƒ‘ッケージをå«ã‚ã‚‹ã‹é™¤å¤–ã™ã‚‹ã‹ã‚’示ã—ã¾ã™ã€‚次ã®ã‚ˆã†ã«æ©Ÿèƒ½ã—ã¾ã™ã€‚ .RS 3 .TP 2 o \f2Serializable\fPを実装ã—ã¦ã„ã‚‹publicã¾ãŸã¯protectedクラスã¯ã€ãã®ã‚¯ãƒ©ã‚¹(ã¾ãŸã¯ãã®ã‚¯ãƒ©ã‚¹ãŒå±žã™ã‚‹ãƒ‘ッケージ)ãŒ\f2@serial exclude\fPã¨ãƒžãƒ¼ã‚¯ã•ã‚Œã¦ã„ãªã„ã‹ãŽã‚Šã€\f2å«ã‚られã¾ã™\fP。 .TP 2 o \f2Serializable\fPを実装ã—ã¦ã„ã‚‹privateã¾ãŸã¯package\-privateクラスã¯ã€ãã®ã‚¯ãƒ©ã‚¹(ã¾ãŸã¯ãã®ã‚¯ãƒ©ã‚¹ãŒå±žã™ã‚‹ãƒ‘ッケージ)ãŒ\f2@serial include\fPã¨ãƒžãƒ¼ã‚¯ã•ã‚Œã¦ã„ãªã„ã‹ãŽã‚Šã€\f2除外ã•ã‚Œã¾ã™\fP。 .RE .LP 例: \f2javax.swing\fPパッケージã¯(\f2package.html\fPã¾ãŸã¯\f2package\-info.java\fP内ã§)\f2@serial exclude\fPã¨ãƒžãƒ¼ã‚¯ã•ã‚Œã¦ã„ã¾ã™ã€‚publicクラス\f2java.security.BasicPermission\fPã¯\f2@serial exclude\fPã¨ãƒžãƒ¼ã‚¯ã•ã‚Œã¦ã„ã¾ã™ã€‚package\-privateクラス\f2java.util.PropertyPermissionCollection\fPã¯\f2@serial include\fPã¨ãƒžãƒ¼ã‚¯ã•ã‚Œã¦ã„ã¾ã™ã€‚ .LP クラス・レベルã§æŒ‡å®šã•ã‚ŒãŸ@serialã‚¿ã‚°ã¯ã€ãƒ‘ッケージ・レベルã§æŒ‡å®šã•ã‚ŒãŸ@serialタグをオーãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã—ã¾ã™ã€‚ .LP ã“れらã®ã‚¿ã‚°ã®ä½¿ç”¨æ–¹æ³•ã®è©³ç´°ã¨ä½¿ç”¨ä¾‹ã¯ã€\f2Javaオブジェクト直列化仕様\fPã®ç¬¬1.6é … .na \f2クラスã®ç›´åˆ—化å¯èƒ½ãªãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ãŠã‚ˆã³ãƒ‡ãƒ¼ã‚¿ã®æ–‡æ›¸åŒ–\fP @ .fi http://docs.oracle.com/javase/7/docs/platform/serialization/spec/serial\-arch.htmlã‚’å‚ç…§ã—ã¦ãã ã•ã„。ã¾ãŸã€ .na \f2直列化ã®FAQ\fP @ .fi http://www.oracle.com/technetwork/java/javase/tech/serializationfaq\-jsp\-136699.html#javadoc_warn_missingã‚‚å‚ç…§ã—ã¦ãã ã•ã„。ã“ã®FAQã«ã¯ã€ã€Œ\-privateスイッãƒã‚’指定ã—ãªã„ã§javadocを実行ã—ã¦ã„ã‚‹ã®ã«privateフィールドã®@serialã‚¿ã‚°ãŒè¦‹ã¤ã‹ã‚‰ãªã„ã¨ã„ã†javadocã®è¦å‘ŠãŒè¡¨ç¤ºã•ã‚Œã‚‹ã€ãªã©ã®ä¸€èˆ¬çš„ãªè³ªå•ã¸ã®å›žç”ãŒè¨˜è¼‰ã•ã‚Œã¦ã„ã¾ã™ã€‚直列化ã•ã‚ŒãŸå½¢å¼ã®ä»•æ§˜ã«ã‚¯ãƒ©ã‚¹ã‚’å«ã‚ã‚‹å ´åˆã«ã¯ã€ .na \f2Oracleã®åŸºæº–\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/serialized\-criteria\-137781.htmlã‚‚å‚ç…§ã—ã¦ãã ã•ã„。 .LP .TP 3 @serialField\ field\-name\ field\-type\ field\-description \f2Serializable\fPクラスã®\f2serialPersistentFields\fPメンãƒãƒ¼ã®\f2ObjectStreamField\fPコンãƒãƒ¼ãƒãƒ³ãƒˆã‚’ドã‚ュメント化ã—ã¾ã™ã€‚å„\f2ObjectStreamField\fPコンãƒãƒ¼ãƒãƒ³ãƒˆã«å¯¾ã—ã¦1ã¤ã®\f2@serialField\fPタグを使用ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .LP .TP 3 @serialData\ data\-description \f2data\-description\fPã¯ã€ç›´åˆ—化ã•ã‚ŒãŸå½¢å¼ã§ã®ãƒ‡ãƒ¼ã‚¿ã®åž‹ã¨é †åºã‚’説明ã™ã‚‹ãƒ†ã‚ストã§ã™ã€‚具体的ã«è¨€ã†ã¨ã€ã“ã®ãƒ‡ãƒ¼ã‚¿ã«ã¯ã€\f2writeObject\fPメソッドã«ã‚ˆã£ã¦æ›¸ãè¾¼ã¾ã‚Œã‚‹çœç•¥å¯èƒ½ãªãƒ‡ãƒ¼ã‚¿ã€ãŠã‚ˆã³\f2Externalizable.writeExternal\fPメソッドã«ã‚ˆã£ã¦æ›¸ãè¾¼ã¾ã‚Œã‚‹ã™ã¹ã¦ã®ãƒ‡ãƒ¼ã‚¿(ベース・クラスをå«ã‚€)ãŒå«ã¾ã‚Œã¾ã™ã€‚ .LP \f2@serialData\fPã‚¿ã‚°ã¯ã€\f2writeObject\fPã€\f2readObject\fPã€\f2writeExternal\fPã€\f2readExternal\fPã€\f2writeReplace\fPã€ãŠã‚ˆã³\f2readResolve\fPメソッドã®ãƒ‰ã‚ュメンテーション・コメント内ã§ä½¿ç”¨ã§ãã¾ã™ã€‚ .LP .TP 3 @since\ since\-text 生æˆãƒ‰ã‚ュメントã«ã€Œå°Žå…¥ã•ã‚ŒãŸãƒãƒ¼ã‚¸ãƒ§ãƒ³ã€è¦‹å‡ºã—ã‚’è¿½åŠ ã—ã¦ã€æŒ‡å®šã•ã‚ŒãŸ\f2since\-text\fPを書ãè¾¼ã¿ã¾ã™ã€‚ã“ã®ãƒ†ã‚ストã«ã¯ã€ç‰¹åˆ¥ãªå†…éƒ¨æ§‹é€ ã¯ã‚ã‚Šã¾ã›ã‚“。ã“ã®ã‚¿ã‚°ã¯ã€ã™ã¹ã¦ã®ãƒ‰ã‚ュメンテーション・コメントã€ã¤ã¾ã‚Šæ¦‚è¦ã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã¾ãŸã¯ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã§æœ‰åŠ¹ã§ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€ç‰¹å®šã®å¤‰æ›´ã¾ãŸã¯æ©Ÿèƒ½ãŒã€\f2since\-text\fPã«ã‚ˆã£ã¦æŒ‡å®šã•ã‚ŒãŸã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ãƒ»ãƒªãƒªãƒ¼ã‚¹ä»¥é™ã€å˜åœ¨ã—ã¦ã„ã‚‹ã“ã¨ã‚’æ„味ã—ã¾ã™ã€‚次ã«ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl @since 1.5 .fl .fl \fP .fi .LP Javaプラットフォームã®ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã®å ´åˆã€ã“ã®ã‚¿ã‚°ã¯ã€JavaプラットフォームAPI仕様ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã‚’示ã—ã¾ã™(リファレンス実装ã«è¿½åŠ ã•ã‚ŒãŸæ™‚期を示ã™ã¨ã¯é™ã‚Šã¾ã›ã‚“)。複数ã®@sinceタグを使用ã§ãã€è¤‡æ•°ã®@authorã‚¿ã‚°ã®ã‚ˆã†ã«æ‰±ã‚ã‚Œã¾ã™ã€‚プãƒã‚°ãƒ©ãƒ è¦ç´ ãŒè¤‡æ•°ã®APIã§ä½¿ç”¨ã•ã‚Œã‚‹å ´åˆã€è¤‡æ•°ã®ã‚¿ã‚°ã‚’使用ã§ãã¾ã™ã€‚ .LP .TP 3 @throws\ class\-name\ description \f2@throws\fPã‚¿ã‚°ã¨\f2@exception\fPã‚¿ã‚°ã¯åŒç¾©ã§ã™ã€‚生æˆãƒ‰ã‚ュメントã«ã€Œã‚¹ãƒãƒ¼ã€å°è¦‹å‡ºã—ã‚’è¿½åŠ ã—ã¦ã€\f2class\-name\fPãŠã‚ˆã³\f2description\fPã®ãƒ†ã‚ストを書ãè¾¼ã¿ã¾ã™ã€‚\f2class\-name\fPã¯ã€ãã®ãƒ¡ã‚½ãƒƒãƒ‰ã‹ã‚‰ã‚¹ãƒãƒ¼ã•ã‚Œã‚‹å¯èƒ½æ€§ã®ã‚る例外ã®åå‰ã§ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã®ãƒ‰ã‚ュメンテーション・コメント内ã§ã®ã¿æœ‰åŠ¹ã§ã™ã€‚ã“ã®ã‚¯ãƒ©ã‚¹ãŒå®Œå…¨æŒ‡å®šã®åå‰ã§è¨˜è¿°ã•ã‚Œã¦ã„ãªã„å ´åˆã€Javadocツールã¯ã€æ¤œç´¢é †åºã«å¾“ã£ã¦ã‚¯ãƒ©ã‚¹ã‚’探ã—ã¾ã™ã€‚åŒã˜ã¾ãŸã¯ç•°ãªã‚‹ä¾‹å¤–ã®ç‰¹å®šã®ãƒ‰ã‚ュメンテーション・コメントã§ã€è¤‡æ•°ã®\f2@throws\fPタグを使用ã§ãã¾ã™ã€‚ .LP ã™ã¹ã¦ã®ãƒã‚§ãƒƒã‚¯æ¸ˆã¿ä¾‹å¤–ãŒãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ã‚ˆã†ã«ã™ã‚‹ãŸã‚ã«ã€\f2@throws\fPã‚¿ã‚°ãŒthrows節内ã®ä¾‹å¤–用ã«å˜åœ¨ã—ãªã„å ´åˆã¯ã€@throwsã‚¿ã‚°ã§ãƒ‰ã‚ュメント化ã•ã‚ŒãŸã‹ã®ã‚ˆã†ã«ã€Javadocツールã«ã‚ˆã£ã¦ä¾‹å¤–ãŒHTML出力ã«èª¬æ˜Žãªã—ã§è‡ªå‹•çš„ã«è¿½åŠ ã•ã‚Œã¾ã™ã€‚ .LP オーãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã•ã‚Œã‚‹ãƒ¡ã‚½ãƒƒãƒ‰å†…ã§ä¾‹å¤–ãŒæ˜Žç¤ºçš„ã«å®£è¨€ã•ã‚Œã¦ã„ã‚‹å ´åˆã®ã¿ã€\f2@throws\fPã®ãƒ‰ã‚ュメントãŒãã®ãƒ¡ã‚½ãƒƒãƒ‰ã‹ã‚‰ã‚µãƒ–クラスã«ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚インタフェース・メソッドã‹ã‚‰å®Ÿè£…メソッドã«ã‚³ãƒ”ーã•ã‚Œã‚‹å ´åˆã‚‚åŒæ§˜ã§ã™ã€‚@throwsã«ãƒ‰ã‚ュメントを継承ã•ã›ã‚‹ã«ã¯ã€{@inheritDoc}を使用ã§ãã¾ã™ã€‚ .LP 詳細ã¯ã€ .na \f2@throwsã‚¿ã‚°ã®ãƒ‰ã‚ュメント\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@exceptionã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .LP .TP 3 {@value\ package.class#field} \f2{@value}\fPãŒé™çš„フィールドã®ãƒ‰ã‚ュメンテーション・コメントã§å¼•æ•°ãªã—ã§ä½¿ç”¨ã•ã‚Œã¦ã„ã‚‹å ´åˆã€ãã®å®šæ•°ã®å€¤ãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl /** .fl * The value of this constant is {@value}. .fl */ .fl public static final String SCRIPT_START = "<script>" .fl .fl \fP .fi .LP ä»»æ„ã®ãƒ‰ã‚ュメンテーション・コメント内ã§å¼•æ•°\f2package.class#field\fPã‚ã‚Šã§ä½¿ç”¨ã•ã‚ŒãŸå ´åˆã¯ã€ãã®æŒ‡å®šã•ã‚ŒãŸå®šæ•°ã®å€¤ãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl /** .fl * Evaluates the script starting with {@value #SCRIPT_START}. .fl */ .fl public String evalScript(String script) { .fl } .fl .fl \fP .fi .LP 引数\f2package.class#field\fPã¯ã€@see引数ã¨åŒä¸€ã®å½¢å¼ã«ãªã‚Šã¾ã™ã€‚ãŸã ã—ã€ãƒ¡ãƒ³ãƒãƒ¼ã¯é™çš„フィールドã§ã‚ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .LP ã“れらã®å®šæ•°ã§ã®å€¤ã¯ã€ .na \f2定数フィールド値\fP @ .fi http://docs.oracle.com/javase/7/docs/api/constant\-values.htmlページã«ã‚‚表示ã•ã‚Œã¾ã™ã€‚ .LP .TP 3 @version\ version\-text \-versionオプションãŒä½¿ç”¨ã•ã‚Œã¦ã„ã‚‹å ´åˆã€ç”Ÿæˆãƒ‰ã‚ュメントã«ã€Œãƒãƒ¼ã‚¸ãƒ§ãƒ³ã€å°è¦‹å‡ºã—ã‚’è¿½åŠ ã—ã¦ã€æŒ‡å®šã•ã‚ŒãŸ\f2version\-text\fPを書ãè¾¼ã¿ã¾ã™ã€‚ã“ã®ã‚¿ã‚°ã¯ã€ã“ã®ã‚³ãƒ¼ãƒ‰ãŒå«ã¾ã‚Œã‚‹ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã®ç¾åœ¨ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ã‚’ä¿æŒã™ã‚‹ã‚ˆã†ã«æ„図ã•ã‚Œã¦ã„ã¾ã™(ã“ã‚Œã«å¯¾ã—ã€@sinceã¯ã€ã“ã®ã‚³ãƒ¼ãƒ‰ãŒå°Žå…¥ã•ã‚ŒãŸãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ã‚’ä¿æŒã—ã¾ã™)。\f2version\-text\fPã«ã¯ã€ç‰¹åˆ¥ãªå†…éƒ¨æ§‹é€ ã¯ã‚ã‚Šã¾ã›ã‚“。ãƒãƒ¼ã‚¸ãƒ§ãƒ³ãƒ»ã‚¿ã‚°ã‚’使用ã§ãã‚‹å ´æ‰€ã‚’èª¿ã¹ã‚‹ã«ã¯ã€ã‚¿ã‚°ã‚’使用ã§ãã‚‹å ´æ‰€ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .LP 1ã¤ã®ãƒ‰ã‚ュメンテーション・コメントã«è¤‡æ•°ã®\f2@version\fPã‚¿ã‚°ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚å¿…è¦ã«å¿œã˜ã¦ã€1ã¤ã®\f2@version\fPã‚¿ã‚°ã«1ã¤ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ã‚’指定ã™ã‚‹ã“ã¨ã‚‚ã€è¤‡æ•°ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ã‚’指定ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚å‰è€…ã®å ´åˆã¯ã€Javadocツールã«ã‚ˆã£ã¦åå‰ã¨åå‰ã®é–“ã«ã‚«ãƒ³ãƒž(\f2,\fP)ã¨ç©ºç™½æ–‡å—ãŒæŒ¿å…¥ã•ã‚Œã¾ã™ã€‚後者ã®å ´åˆã¯ã€ãƒ†ã‚スト全体ãŒã€è§£æžã•ã‚Œã‚‹ã“ã¨ãªãã€ç”Ÿæˆãƒ‰ã‚ュメントã«ãã®ã¾ã¾ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€ã‚«ãƒ³ãƒžã§ã¯ãªãã€å„言語ã«å¯¾å¿œã—ãŸåå‰åŒºåˆ‡ã‚Šæ–‡å—を使用ã™ã‚‹å¿…è¦ãŒã‚ã‚‹ã¨ãã¯ã€1ã¤ã®ã‚¿ã‚°ã«è¤‡æ•°ã®åå‰ã‚’指定ã—ã¦ãã ã•ã„。 .LP 詳細ã¯ã€ .na \f2@versionã‚¿ã‚°ã®ãƒ‰ã‚ュメント\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#@versionã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .RE .SS タグを使用ã§ãã‚‹å ´æ‰€ .LP ã“ã“ã§ã¯ã€ã‚¿ã‚°ã‚’使用ã§ãã‚‹å ´æ‰€ã«ã¤ã„ã¦èª¬æ˜Žã—ã¾ã™ã€‚\f2@see\fPã€\f2@since\fPã€\f2@deprecated\fPã€\f2{@link}\fPã€\f2{@linkplain}\fPã€ãŠã‚ˆã³\f2{@docroot}\fPã¯ã€ã™ã¹ã¦ã®ãƒ‰ã‚ュメンテーション・コメントã§ä½¿ç”¨ã§ãã¾ã™ã€‚ .SS 概è¦ã®ãƒ‰ã‚ュメンテーション・タグ .LP 概è¦ã‚¿ã‚°ã¯ã€æ¦‚è¦ãƒšãƒ¼ã‚¸ã®ãƒ‰ã‚ュメンテーション・コメントã§ä½¿ç”¨ã§ãã‚‹ã‚¿ã‚°ã§ã™(ã“ã®ãƒ‰ã‚ュメンテーション・コメントã¯ã€é€šå¸¸\f2overview.html\fPã¨ã„ã†åå‰ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«å†…ã«ã‚ã‚Šã¾ã™)。他ã®ãƒ‰ã‚ュメンテーション・コメントã®å ´åˆã¨åŒæ§˜ã«ã€ã“れらã®ã‚¿ã‚°ã¯ã€ä¸»èª¬æ˜Žã®å¾Œã§ä½¿ç”¨ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .LP \f3注æ„\fP \- ãƒãƒ¼ã‚¸ãƒ§ãƒ³1.2ã§ã¯ã€æ¦‚è¦ãƒ‰ã‚ュメント内ã®\f2{@link}\fPã‚¿ã‚°ã«ãƒã‚°ãŒã‚ã‚Šã¾ã™ã€‚テã‚ストã¯æ£ã—ã表示ã•ã‚Œã¾ã™ãŒã€ãƒªãƒ³ã‚¯ãŒè¨å®šã•ã‚Œã¾ã›ã‚“。ç¾åœ¨ã®ã¨ã“ã‚ã€\f2{@docRoot}\fPã‚¿ã‚°ã¯ã€æ¦‚è¦ãƒ‰ã‚ュメント内ã§ã¯æ©Ÿèƒ½ã—ã¾ã›ã‚“。 .LP \f3概è¦ã‚¿ã‚°\fP .RS 3 .TP 2 o \f2@see\fP .TP 2 o \f2@since\fP .TP 2 o \f2@author\fP .TP 2 o \f2@version\fP .TP 2 o \f2{@link}\fP .TP 2 o \f2{@linkplain}\fP .TP 2 o \f2{@docRoot}\fP .RE .SS パッケージ・ドã‚ュメンテーション・タグ .LP パッケージ・タグã¯ã€ãƒ‘ッケージã®ãƒ‰ã‚ュメンテーション・コメントã§ä½¿ç”¨ã§ãã‚‹ã‚¿ã‚°ã§ã™(ã“ã®ãƒ‰ã‚ュメンテーション・コメントã¯\f2package.html\fPã¾ãŸã¯\f2package\-info.java\fPã¨ã„ã†åå‰ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«å†…ã«ã‚ã‚Šã¾ã™)。ã“ã“ã§ä½¿ç”¨ã§ãã‚‹\f2@serial\fPã‚¿ã‚°ã¯ã€\f2include\fPã¾ãŸã¯\f2exclude\fP引数を指定ã—ãŸã‚‚ã®ã®ã¿ã§ã™ã€‚ .LP \f3パッケージ・タグ\fP .RS 3 .TP 2 o \f2@see\fP .TP 2 o \f2@since\fP .TP 2 o \f2@serial\fP .TP 2 o \f2@author\fP .TP 2 o \f2@version\fP .TP 2 o \f2{@link}\fP .TP 2 o \f2{@linkplain}\fP .TP 2 o \f2{@docRoot}\fP .RE .SS クラスãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ãƒ»ãƒ‰ã‚ュメンテーション・タグ .LP 次ã«ã€ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®ãƒ‰ã‚ュメンテーション・コメントã§ä½¿ç”¨ã§ãるタグを示ã—ã¾ã™ã€‚ã“ã“ã§ä½¿ç”¨ã§ãã‚‹\f2@serial\fPã‚¿ã‚°ã¯ã€\f2include\fPã¾ãŸã¯\f2exclude\fP引数を指定ã—ãŸã‚‚ã®ã®ã¿ã§ã™ã€‚ .LP \f3クラスãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ãƒ»ã‚¿ã‚°\fP .RS 3 .TP 2 o \f2@see\fP .TP 2 o \f2@since\fP .TP 2 o \f2@deprecated\fP .TP 2 o \f2@serial\fP .TP 2 o \f2@author\fP .TP 2 o \f2@version\fP .TP 2 o \f2{@link}\fP .TP 2 o \f2{@linkplain}\fP .TP 2 o \f2{@docRoot}\fP .RE \f3クラス・コメントã®ä¾‹:\fP .nf \f3 .fl /** .fl * A class representing a window on the screen. .fl * For example: .fl * <pre> .fl * Window win = new Window(parent); .fl * win.show(); .fl * </pre> .fl * .fl * @author Sami Shaio .fl * @version 1.13, 06/08/06 .fl * @see java.awt.BaseWindow .fl * @see java.awt.Button .fl */ .fl class Window extends BaseWindow { .fl ... .fl } .fl \fP .fi .SS フィールド・ドã‚ュメンテーション・タグ .LP 次ã«ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®ãƒ‰ã‚ュメンテーション・コメントã§ä½¿ç”¨ã§ãるタグを示ã—ã¾ã™ã€‚ .LP \f3フィールド・タグ\fP .RS 3 .TP 2 o \f2@see\fP .TP 2 o \f2@since\fP .TP 2 o \f2@deprecated\fP .TP 2 o \f2@serial\fP .TP 2 o \f2@serialField\fP .TP 2 o \f2{@link}\fP .TP 2 o \f2{@linkplain}\fP .TP 2 o \f2{@docRoot}\fP .TP 2 o \f2{@value}\fP .RE \f3フィールド・コメントã®ä¾‹:\fP .nf \f3 .fl /** .fl * The X\-coordinate of the component. .fl * .fl * @see #getLocation() .fl */ .fl int x = 1263732; .fl \fP .fi .SS コンストラクタãŠã‚ˆã³ãƒ¡ã‚½ãƒƒãƒ‰ãƒ»ãƒ‰ã‚ュメンテーション・タグ .LP 次ã«ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã¾ãŸã¯ãƒ¡ã‚½ãƒƒãƒ‰ã®ãƒ‰ã‚ュメンテーション・コメントã§ä½¿ç”¨ã§ãるタグを示ã—ã¾ã™ã€‚ãŸã ã—ã€\f2@return\fPã¯ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã§ã¯ä½¿ç”¨ã§ããšã€\f2{@inheritDoc}\fPã«ã¯ç‰¹å®šã®åˆ¶é™ãŒã‚ã‚Šã¾ã™ã€‚\f2@serialData\fPã‚¿ã‚°ã¯ç‰¹å®šã®ç›´åˆ—化メソッドã®ãƒ‰ã‚ュメンテーション・コメントã§ã®ã¿ä½¿ç”¨ã§ãã¾ã™ã€‚ .LP \f3メソッドãŠã‚ˆã³ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ãƒ»ã‚¿ã‚°\fP .RS 3 .TP 2 o \f2@see\fP .TP 2 o \f2@since\fP .TP 2 o \f2@deprecated\fP .TP 2 o \f2@param\fP .TP 2 o \f2@return\fP .TP 2 o \f2@throws\fPã¨\f2@exception\fP .TP 2 o \f2@serialData\fP .TP 2 o \f2{@link}\fP .TP 2 o \f2{@linkplain}\fP .TP 2 o \f2{@inheritDoc}\fP .TP 2 o \f2{@docRoot}\fP .RE \f3メソッドã®ãƒ‰ã‚ュメンテーション・コメントã®ä¾‹:\fP .nf \f3 .fl /** .fl * Returns the character at the specified index. An index .fl * ranges from <code>0</code> to <code>length() \- 1</code>. .fl * .fl * @param index the index of the desired character. .fl * @return the desired character. .fl * @exception StringIndexOutOfRangeException .fl * if the index is not in the range <code>0</code> .fl * to <code>length()\-1</code>. .fl * @see java.lang.Character#charValue() .fl */ .fl public char charAt(int index) { .fl ... .fl } .fl \fP .fi .SH "オプション" .LP Javadocツールã¯ã€ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã‚’使用ã—ã¦å‡ºåŠ›ã‚’決定ã—ã¾ã™ã€‚Javadocツールã¯ã€\-docletオプションã§ã‚«ã‚¹ã‚¿ãƒ ・ドックレットãŒæŒ‡å®šã•ã‚Œã¦ã„ã‚‹å ´åˆä»¥å¤–ã¯ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®æ¨™æº–ドックレットを使用ã—ã¾ã™ã€‚Javadocツールã«ã¯ã€ä»»æ„ã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã¨ã¨ã‚‚ã«ä½¿ç”¨ã§ãるコマンドライン・オプションãŒã‚ã‚Šã¾ã™ã€‚ã“れらã®ã‚ªãƒ—ションã«ã¤ã„ã¦ã¯ã€å¾Œè¿°ã®Javadocオプションã§èª¬æ˜Žã—ã¾ã™ã€‚標準ドックレットã§ã¯ã€ã“ã®ä»–ã«ã€ã„ãã¤ã‹ã®è¿½åŠ ã®ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ãƒ»ã‚ªãƒ—ションãŒæä¾›ã•ã‚Œã¾ã™ã€‚ã“れらã®ã‚ªãƒ—ションã«ã¤ã„ã¦ã¯ã€å¾Œè¿°ã®æ¨™æº–ドックレットãŒæä¾›ã™ã‚‹ã‚ªãƒ—ションã§èª¬æ˜Žã—ã¾ã™ã€‚ã©ã®ã‚ªãƒ—ションåã‚‚ã€å¤§æ–‡å—ã¨å°æ–‡å—ãŒåŒºåˆ¥ã•ã‚Œã¾ã›ã‚“。ãŸã ã—ã€ã‚ªãƒ—ションã®å¼•æ•°ã§ã¯ã€å¤§æ–‡å—ã¨å°æ–‡å—ãŒåŒºåˆ¥ã•ã‚Œã¾ã™ã€‚ .LP オプションã¯æ¬¡ã®ã¨ãŠã‚Šã§ã™ã€‚ .LP .TS .if \n+(b.=1 .nr d. \n(.c-\n(c.-1 .de 35 .ps \n(.s .vs \n(.vu .in \n(.iu .if \n(.u .fi .if \n(.j .ad .if \n(.j=0 .na .. .nf .nr #~ 0 .if n .nr #~ 0.6n .ds #d .d .if \(ts\n(.z\(ts\(ts .ds #d nl .fc .nr 33 \n(.s .rm 80 81 82 .nr 34 \n(.lu .eo .am 80 .br .di a+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(80 .ll \n(80u .in 0 \-\f21.1\fP .br \-author .br \-\f2bootclasspath\fP .br \-bottom .br \-\f2breakiterator\fP .br \-charset .br \-\f2classpath\fP .br \-d .br \-docencoding .br \-docfilessubdirs .br \-\f2doclet\fP .br \-\f2docletpath\fP .br \-doctitle .br \-\f2encoding\fP .br \-\f2exclude\fP .br \-excludedocfilessubdir .br \-\f2extdirs\fP .br \-footer .br \-group .br .br .di .nr a| \n(dn .nr a- \n(dl .. .ec \ .eo .am 81 .br .di b+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(81 .ll \n(81u .in 0 \-header .br \-\f2help\fP .br \-helpfile .br \-\f2J\fP .br \-keywords .br \-link .br \-linkoffline .br \-linksource .br \-\f2locale\fP .br \-nocomment .br \-nodeprecated .br \-nodeprecatedlist .br \-nohelp .br \-noindex .br \-nonavbar .br \-noqualifier .br \-nosince .br \-notimestamp .br \-notree .br \-\f2overview\fP .br \-\f2package\fP .br .br .di .nr b| \n(dn .nr b- \n(dl .. .ec \ .eo .am 82 .br .di c+ .35 .ft \n(.f .ll \n(34u*1u/4u .if \n(.l<\n(82 .ll \n(82u .in 0 \-\f2private\fP .br \-\f2protected\fP .br \-\f2public\fP .br \-\f2quiet\fP .br \-serialwarn .br \-\f2source\fP .br \-\f2sourcepath\fP .br \-sourcetab .br \-splitindex .br \-stylesheetfile .br \-\f2subpackages\fP .br \-tag .br \-taglet .br \-tagletpath .br \-top .br \-title .br \-use .br \-\f2verbose\fP .br \-version .br \-windowtitle .br .br .di .nr c| \n(dn .nr c- \n(dl .. .ec \ .35 .nf .ll \n(34u .nr 80 0 .80 .rm 80 .nr 38 \n(a- .if \n(80<\n(38 .nr 80 \n(38 .nr 81 0 .81 .rm 81 .nr 38 \n(b- .if \n(81<\n(38 .nr 81 \n(38 .nr 82 0 .82 .rm 82 .nr 38 \n(c- .if \n(82<\n(38 .nr 82 \n(38 .35 .nf .ll \n(34u .nr 38 1n .nr 79 0 .nr 40 \n(79+(0*\n(38) .nr 80 +\n(40 .nr 41 \n(80+(3*\n(38) .nr 81 +\n(41 .nr 42 \n(81+(3*\n(38) .nr 82 +\n(42 .nr TW \n(82 .if t .if \n(TW>\n(.li .tm Table at line 2003 file Input is too wide - \n(TW units .fc .nr #T 0-1 .nr #a 0-1 .eo .de T# .ds #d .d .if \(ts\n(.z\(ts\(ts .ds #d nl .mk ## .nr ## -1v .ls 1 .ls .. .ec .ne \n(a|u+\n(.Vu .ne \n(b|u+\n(.Vu .ne \n(c|u+\n(.Vu .if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v) .if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v) .if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v) .ta \n(80u \n(81u \n(82u .nr 31 \n(.f .nr 35 1m \&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u' .mk ## .nr 31 \n(## .sp |\n(##u-1v .nr 37 \n(40u .in +\n(37u .a+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(##u-1v .nr 37 \n(41u .in +\n(37u .b+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(##u-1v .nr 37 \n(42u .in +\n(37u .c+ .in -\n(37u .mk 32 .if \n(32>\n(31 .nr 31 \n(32 .sp |\n(31u .fc .nr T. 1 .T# 1 .35 .rm a+ .rm b+ .rm c+ .TE .if \n-(b.=0 .nr c. \n(.c-\n(d.-127 .LP \f2イタリック\fPã§ç¤ºã•ã‚ŒãŸã‚ªãƒ—ションã¯ã€Javadocã®åŸºæœ¬ã‚ªãƒ—ションã§ã‚ã‚Šã€Javadocツールã®ãƒ•ãƒãƒ³ãƒˆã‚¨ãƒ³ãƒ‰ã«ã‚ˆã£ã¦æä¾›ã•ã‚Œã€ã™ã¹ã¦ã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã§ä½¿ç”¨ã§ãã¾ã™ã€‚標準ドックレット自体ã¯ã€ã‚¤ã‚¿ãƒªãƒƒã‚¯ã§ãªã„オプションをæä¾›ã—ã¾ã™ã€‚ .SS Javadocオプション .RS 3 .TP 3 \-overview \ path/filename Javadocã«å¯¾ã—ã¦ã€\f2path/filename\fPã§æŒ‡å®šã•ã‚ŒãŸã€Œã‚½ãƒ¼ã‚¹ã€ãƒ•ã‚¡ã‚¤ãƒ«ã‹ã‚‰æ¦‚è¦ãƒ‰ã‚ュメント用ã®ãƒ†ã‚ストをå–å¾—ã—ã€ãã®ãƒ†ã‚ストを概è¦ãƒšãƒ¼ã‚¸(\f2overview\-summary.html\fP)ã«é…ç½®ã™ã‚‹ã‚ˆã†ã«æŒ‡å®šã—ã¾ã™ã€‚\f2path/filename\fPã¯ã€ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰ã®ç›¸å¯¾ãƒ‘スã§ã™ã€‚ .br .br \f2filename\fPã§ä»»æ„ã®åå‰ã‚’使用ã—ã€\f2path\fPã§ä»»æ„ã®é…置先を指定ã§ãã¾ã™ãŒã€é€šå¸¸ã¯\f2overview.html\fPã¨ã„ã†åå‰ã‚’付ã‘ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リー内ã®æœ€ä¸Šä½ãƒ‘ッケージ・ディレクトリをå«ã‚€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«é…ç½®ã—ã¾ã™ã€‚ã“ã®å ´æ‰€ã«é…ç½®ã™ã‚‹ã¨ã€ãƒ‘ッケージをドã‚ュメント化ã™ã‚‹ã¨ãã«\f2path\fPを指定ã™ã‚‹å¿…è¦ãŒãªããªã‚Šã¾ã™ã€‚ã“ã‚Œã¯ã€\f2\-sourcepath\fPã«ã‚ˆã£ã¦ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ãŒæŒ‡ã—示ã•ã‚Œã‚‹ã‹ã‚‰ã§ã™ã€‚ãŸã¨ãˆã°ã€\f2java.lang\fPパッケージã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーãŒ\f2/src/classes/java/lang/\fPã®å ´åˆã€æ¦‚è¦ãƒ•ã‚¡ã‚¤ãƒ«ã‚’\f2/src/classes/overview.html\fPã«é…ç½®ã§ãã¾ã™ã€‚使用例をå‚ç…§ã—ã¦ãã ã•ã„。 .br .br \f2path/filename\fPã§æŒ‡å®šã™ã‚‹ãƒ•ã‚¡ã‚¤ãƒ«ã«ã¤ã„ã¦ã¯ã€æ¦‚è¦ã‚³ãƒ¡ãƒ³ãƒˆãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .br .br 概è¦ãƒšãƒ¼ã‚¸ãŒä½œæˆã•ã‚Œã‚‹ã®ã¯ã€Javadocã«è¤‡æ•°ã®ãƒ‘ッケージåを渡ã—ãŸå ´åˆã®ã¿ã§ã™ã€‚詳細ã¯ã€HTMLフレームをå‚ç…§ã—ã¦ãã ã•ã„。 .br .br 概è¦ãƒšãƒ¼ã‚¸ã®ã‚¿ã‚¤ãƒˆãƒ«ã¯ã€\f2\-doctitle\fPã«ã‚ˆã£ã¦è¨å®šã•ã‚Œã¾ã™ã€‚ .TP 3 \-public publicクラスãŠã‚ˆã³ãƒ¡ãƒ³ãƒãƒ¼ã®ã¿ã‚’表示ã—ã¾ã™ã€‚ .TP 3 \-protected protectedãŠã‚ˆã³publicã®ã‚¯ãƒ©ã‚¹ã¨ãƒ¡ãƒ³ãƒãƒ¼ã®ã¿ã‚’表示ã—ã¾ã™ã€‚ã“ã‚ŒãŒãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã§ã™ã€‚ .TP 3 \-package packageã€protectedã€ãŠã‚ˆã³publicã®ã‚¯ãƒ©ã‚¹ã¨ãƒ¡ãƒ³ãƒãƒ¼ã®ã¿ã‚’表示ã—ã¾ã™ã€‚ .TP 3 \-private ã™ã¹ã¦ã®ã‚¯ãƒ©ã‚¹ã¨ãƒ¡ãƒ³ãƒãƒ¼ã‚’表示ã—ã¾ã™ã€‚ .TP 3 \-help オンライン・ヘルプを表示ã—ã¾ã™ã€‚Javadocã¨ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã®ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ãƒ»ã‚ªãƒ—ションãŒãƒªã‚¹ãƒˆã•ã‚Œã¾ã™ã€‚ .TP 3 \-doclet\ class ドã‚ュメントã®ç”Ÿæˆã«ä½¿ç”¨ã™ã‚‹ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã‚’èµ·å‹•ã™ã‚‹ãŸã‚ã®ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’指定ã—ã¾ã™ã€‚完全修飾åを指定ã—ã¦ãã ã•ã„。ã“ã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã«ã‚ˆã‚Šã€å‡ºåŠ›ã®å†…容ã¨å½¢å¼ãŒå®šç¾©ã•ã‚Œã¾ã™ã€‚\f4\-doclet\fPオプションãŒä½¿ç”¨ã•ã‚Œã¦ã„ãªã„å ´åˆã€Javadocã¯ã€æ¨™æº–ドックレットを使用ã—ã¦ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®HTMLå½¢å¼ã‚’生æˆã—ã¾ã™ã€‚ã“ã®ã‚¯ãƒ©ã‚¹ã«ã¯\f2start(Root)\fPメソッドãŒå«ã¾ã‚Œã¦ã„ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã“ã®èµ·å‹•ã‚¯ãƒ©ã‚¹ã¸ã®ãƒ‘スã¯\f2\-docletpath\fPオプションã«ã‚ˆã£ã¦å®šç¾©ã•ã‚Œã¾ã™ã€‚ .br .br 詳細ã¯ã€ .na \f2ドックレットã®æ¦‚è¦\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/doclet/overview.htmlã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .TP 3 \-docletpath\ classpathlist \f2\-doclet\fPオプションã§æŒ‡å®šã•ã‚ŒãŸãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆé–‹å§‹ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã€ãŠã‚ˆã³ãã®ã‚¯ãƒ©ã‚¹ãŒä¾å˜ã™ã‚‹ã™ã¹ã¦ã®JARファイルã¸ã®ãƒ‘スを指定ã—ã¾ã™ã€‚開始クラス・ファイルãŒjarファイル内ã«ã‚ã‚‹å ´åˆã€æ¬¡ã®ä¾‹ã®ã‚ˆã†ã«jarファイルã®ãƒ‘スãŒæŒ‡å®šã•ã‚Œã¾ã™ã€‚絶対パスã¾ãŸã¯ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰ã®ç›¸å¯¾ãƒ‘スを指定ã§ãã¾ã™ã€‚\f2classpathlist\fPã«è¤‡æ•°ã®ãƒ‘スやJARファイルãŒå«ã¾ã‚Œã‚‹å ´åˆã«ã¯ã€ãれらをSolarisã®å ´åˆã¯ã‚³ãƒãƒ³(:)ã§ã€Windowsã®å ´åˆã¯ã‚»ãƒŸã‚³ãƒãƒ³(;)ã§ãã‚Œãžã‚ŒåŒºåˆ‡ã‚Šã¾ã™ã€‚目的ã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆé–‹å§‹ã‚¯ãƒ©ã‚¹ãŒã™ã§ã«æ¤œç´¢ãƒ‘ス内ã«ã‚ã‚‹å ´åˆã¯ã€ã“ã®ã‚ªãƒ—ションã¯ä¸è¦ã§ã™ã€‚ .br .br 詳細ã¯ã€ .na \f2ドックレットã®æ¦‚è¦\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/doclet/overview.htmlã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .TP 3 \-1.1 \f2ã“ã®æ©Ÿèƒ½ã¯Javadoc 1.4ã‹ã‚‰å‰Šé™¤ã•ã‚Œã¾ã—ãŸã€‚代替機能ã¯ã‚ã‚Šã¾ã›ã‚“。ã“ã®ã‚ªãƒ—ションã¯ã€Javadoc 1.1ã«ã‚ˆã£ã¦ç”Ÿæˆã•ã‚Œã‚‹ã®ã¨åŒã˜å¤–見ã¨æ©Ÿèƒ½ã‚’æŒã¤ãƒ‰ã‚ュメントを作æˆã™ã‚‹ãŸã‚ã®ã‚‚ã®ã§ã—ãŸ(ãƒã‚¹ãƒˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã¯ã‚µãƒãƒ¼ãƒˆã•ã‚Œã¦ã„ã¾ã›ã‚“)。ã“ã®ã‚ªãƒ—ションãŒå¿…è¦ãªå ´åˆã¯ã€Javadoc 1.2ã¾ãŸã¯1.3ã‚’ã‹ã‚ã‚Šã«ä½¿ç”¨ã—ã¦ãã ã•ã„。\fP .TP 3 \-source release å—ã‘付ã‘るソース・コードã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã‚’指定ã—ã¾ã™ã€‚\f2release\fPã«ã¯æ¬¡ã®å€¤ã‚’指定ã§ãã¾ã™ã€‚ .RS 3 .TP 2 o \f31.5\fP \- Javadocã¯ã€JDK 1.5ã§å°Žå…¥ã•ã‚ŒãŸç·ç§°ãŠã‚ˆã³ä»–ã®è¨€èªžæ©Ÿèƒ½ã‚’å«ã‚€ã‚³ãƒ¼ãƒ‰ã‚’å—ã‘付ã‘ã¾ã™ã€‚\f3\-source\fPフラグãŒä½¿ç”¨ã•ã‚Œãªã‹ã£ãŸå ´åˆã®ã‚³ãƒ³ãƒ‘イラã®ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆå‹•ä½œã¯ã€1.5ã®ã‚‚ã®ã«ãªã‚Šã¾ã™ã€‚ .TP 2 o \f31.4\fP \- Javadocã¯ã€JDK 1.4ã§å°Žå…¥ã•ã‚ŒãŸã‚¢ã‚µãƒ¼ã‚·ãƒ§ãƒ³ã‚’å«ã‚€ã‚³ãƒ¼ãƒ‰ã‚’å—ã‘付ã‘ã¾ã™ã€‚ .TP 2 o \f31.3\fP \- Javadocã¯ã€JDK 1.3以é™ã«å°Žå…¥ã•ã‚ŒãŸã‚¢ã‚µãƒ¼ã‚·ãƒ§ãƒ³ã€ç·ç§°ã€ã¾ãŸã¯ä»–ã®è¨€èªžæ©Ÿèƒ½ã‚’サãƒãƒ¼ãƒˆã—ã¾ã›ã‚“。 .RE javacã§ã‚³ãƒ¼ãƒ‰ã‚’コンパイルã™ã‚‹ã¨ãã«ä½¿ç”¨ã—ãŸå€¤ã«å¯¾å¿œã™ã‚‹\f2release\fPã®å€¤ã‚’使用ã—ã¾ã™ã€‚ .TP 3 \-sourcepath\ sourcepathlist パッケージåã¾ãŸã¯\f2\-subpackages\fPã‚’\f2javadoc\fPコマンドã«æ¸¡ã™ã¨ãã«ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«(.\f2.java\fP)を見ã¤ã‘ã‚‹ãŸã‚ã®æ¤œç´¢ãƒ‘スを指定ã—ã¾ã™ã€‚\f2sourcepathlist\fPã«ã¯ã€ã‚³ãƒãƒ³(\f2:\fP)ã§åŒºåˆ‡ã£ã¦è¤‡æ•°ã®ãƒ‘スをå«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚Javadocツールã¯ã€æŒ‡å®šã•ã‚ŒãŸãƒ‘ス以下ã®ã™ã¹ã¦ã®ã‚µãƒ–ディレクトリを検索ã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションを使用ã—ã¦ã€ãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®ä½ç½®ã®ã¿ã§ãªãã€ãれ自体ã¯ãƒ‰ã‚ュメント化ã•ã‚Œãªã„ãŒãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‹ã‚‰ç¶™æ‰¿ã•ã‚ŒãŸã‚³ãƒ¡ãƒ³ãƒˆã‚’æŒã¤ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®ä½ç½®ã‚‚確èªã§ãã¾ã™ã€‚ .br .br \f2\-sourcepath\fPオプションを使用ã§ãã‚‹ã®ã¯ã€javadocコマンドã«ãƒ‘ッケージåを渡ã™å ´åˆã®ã¿ã§ã™ã€‚ã“ã®ãƒ‘スã‹ã‚‰ã¯ã€\f2javadoc\fPコマンドã«æ¸¡ã•ã‚Œã‚‹\f2.java\fPファイルã¯æ¤œç´¢ã•ã‚Œã¾ã›ã‚“。(\f2.java\fPファイルを検索ã™ã‚‹ã«ã¯ã€ãã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«cdã«ã‚ˆã£ã¦ç§»å‹•ã™ã‚‹ã‹ã€ã¾ãŸã¯å„ファイルã®å…ˆé ã«ãƒ‘スをå«ã‚ã¾ã™(1ã¤ä»¥ä¸Šã®ã‚¯ãƒ©ã‚¹ã®ãƒ‰ã‚ュメント化をå‚ç…§)。)\f2\-sourcepath\fPãŒçœç•¥ã•ã‚ŒãŸå ´åˆã€Javadocã¯ã€ã‚¯ãƒ©ã‚¹ãƒ»ãƒ‘スを使用ã—ã¦ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’検索ã—ã¾ã™(\-classpathã‚’å‚ç…§)。ã—ãŸãŒã£ã¦ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®\-sourcepathã¯ã€ã‚¯ãƒ©ã‚¹ãƒ»ãƒ‘スã®å€¤ã§ã™ã€‚\-classpathã‚’çœç•¥ã—ã¦ãƒ‘ッケージåã‚’Javadocã«æ¸¡ã™ã¨ã€Javadocã¯ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª(ãŠã‚ˆã³ãã®ã‚µãƒ–ディレクトリ)ã‹ã‚‰ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’検索ã—ã¾ã™ã€‚ .br .br \f2sourcepathlist\fPã«ã¯ã€ãƒ‰ã‚ュメント化ã™ã‚‹ãƒ‘ッケージã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーã®ãƒ«ãƒ¼ãƒˆãƒ»ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’è¨å®šã—ã¾ã™ã€‚ãŸã¨ãˆã°ã€\f2com.mypackage\fPã¨ã„ã†åå‰ã®ãƒ‘ッケージをドã‚ュメント化ã™ã‚‹å ´åˆã«ã€ãã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒæ¬¡ã®å ´æ‰€ã«ã‚ã‚‹ã¨ã—ã¾ã™ã€‚ .nf \f3 .fl /home/user/src/com/mypackage/*.java .fl \fP .fi ã“ã®å ´åˆã€æ¬¡ã®ã‚ˆã†ã«ã—ã¦\f2sourcepath\fPã‚’ã€\f2com/mypackage\fPã‚’å«ã‚€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã§ã‚ã‚‹\f2/home/user/src\fPã«æŒ‡å®šã—ã¦ã‹ã‚‰ã€ãƒ‘ッケージå\f2com.mypackage\fPを指定ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-sourcepath /home/user/src/ com.mypackage\fP .fl .fi ã“ã®æ–¹æ³•ã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ‘スã®å€¤ã¨ãƒ‘ッケージåを連çµã—ã¦ã€ãƒ‰ãƒƒãƒˆã‚’スラッシュ「/ã€ã«å¤‰æ›´ã™ã‚‹ã¨ã€ãƒ‘ッケージã®ãƒ•ãƒ«ãƒ‘ス\f2/home/user/src/com/mypackage\fPã«ãªã‚‹ã“ã¨ã«æ°—付ãã¨è¦šãˆã‚„ã™ã„ã§ã™ã€‚ .br .br 2ã¤ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ‘スをè¨å®šã™ã‚‹ã«ã¯ã€æ¬¡ã®ã‚ˆã†ã«ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-sourcepath /home/user1/src:/home/user2/src com.mypackage\fP .fl .fi .TP 3 \-classpath\ classpathlist JavadocãŒå‚照クラス(\f2.class\fPファイル)ã®æ¤œç´¢ã‚’è¡Œã†ã¨ãã«ä½¿ç”¨ã™ã‚‹ãƒ‘スを指定ã—ã¾ã™ã€‚å‚照クラスã¨ã¯ã€ãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ã¨ã€ãれらã®ã‚¯ãƒ©ã‚¹ã«ã‚ˆã£ã¦å‚ç…§ã•ã‚Œã‚‹ã™ã¹ã¦ã®ã‚¯ãƒ©ã‚¹ã®ã“ã¨ã§ã™ã€‚\f2classpathlist\fPã«ã¯ã€ã‚³ãƒãƒ³(\f2:\fP)ã§åŒºåˆ‡ã£ã¦è¤‡æ•°ã®ãƒ‘スをå«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚Javadocツールã¯ã€æŒ‡å®šã•ã‚ŒãŸãƒ‘ス以下ã®ã™ã¹ã¦ã®ã‚µãƒ–ディレクトリを検索ã—ã¾ã™ã€‚\f2classpathlist\fPを指定ã™ã‚‹ã¨ãã¯ã€ .na \f2クラス・パス\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/tools/index.html#generalã®ãƒ‰ã‚ュメントã«ã‚る指示ã«å¾“ã£ã¦ãã ã•ã„。 .br .br \f2\-sourcepath\fPãŒçœç•¥ã•ã‚ŒãŸå ´åˆã€Javadocツールã¯ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’検索ã™ã‚‹ã¨ãã®ã¿ã§ãªãã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’検索ã™ã‚‹ã¨ãã«ã‚‚\f2\-classpath\fPを使用ã—ã¾ã™(下ä½äº’æ›æ€§ã®ãŸã‚)。ã—ãŸãŒã£ã¦ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¨ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’別々ã®ãƒ‘スã‹ã‚‰æ¤œç´¢ã™ã‚‹å¿…è¦ãŒã‚ã‚‹å ´åˆã¯ã€\f2\-sourcepath\fPã¨\f2\-classpath\fPã®ä¸¡æ–¹ã‚’使用ã—ã¾ã™ã€‚ .br .br ãŸã¨ãˆã°ã€\f2com.mypackage\fPをドã‚ュメント化ã™ã‚‹å ´åˆã«ã€ãã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª\f2/home/user/src/com/mypackage\fPã«ã‚ã‚Šã€ã“ã®ãƒ‘ッケージãŒ\f2/home/user/lib\fP内ã®ãƒ©ã‚¤ãƒ–ラリã«ä¾å˜ã—ã¦ã„ã‚‹ã¨ãã€æ¬¡ã®ã‚ˆã†ã«æŒ‡å®šã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-classpath /home/user/lib \-sourcepath /home/user/src com.mypackage\fP .fl .fi ä»–ã®ãƒ„ールã¨åŒæ§˜ã«ã€\f2\-classpath\fPãŒæŒ‡å®šã•ã‚Œã¦ã„ãªã„å ´åˆã€CLASSPATH環境変数ãŒè¨å®šã•ã‚Œã¦ã„ã‚Œã°ã€Javadocツールã¯ãã®ç’°å¢ƒå¤‰æ•°ã‚’使用ã—ã¾ã™ã€‚ã©ã¡ã‚‰ã‚‚è¨å®šã•ã‚Œã¦ã„ãªã„å ´åˆã€Javadocツールã¯ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰ã‚¯ãƒ©ã‚¹ã‚’検索ã—ã¾ã™ã€‚ .br .br JavadocツールãŒ\f2\-classpath\fPを使用ã—ã¦ãƒ¦ãƒ¼ã‚¶ãƒ¼ãƒ»ã‚¯ãƒ©ã‚¹ã‚’検索ã™ã‚‹æ–¹æ³•ã«ã¤ã„ã¦ã®ã€æ‹¡å¼µæ©Ÿèƒ½ã‚¯ãƒ©ã‚¹ã‚„ブートストラップ・クラスã«é–¢é€£ã—ãŸè©³ç´°ã¯ã€ .na \f2クラスã®æ¤œç´¢æ–¹æ³•\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/tools/findingclasses.htmlã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .br .br 便宜上ã€\f2*\fPã®ãƒ™ãƒ¼ã‚¹åã‚’å«ã‚€ã‚¯ãƒ©ã‚¹ãƒ»ãƒ‘スè¦ç´ ã¯ã€\f2.jar\fPã¾ãŸã¯\f2.JAR\fPã‚’æ‹¡å¼µåã«æŒã¤ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªå†…ã®ã™ã¹ã¦ã®ãƒ•ã‚¡ã‚¤ãƒ«ã®ãƒªã‚¹ãƒˆã‚’指定ã™ã‚‹ã®ã¨åŒç‰ã¨ã¿ãªã•ã‚Œã¾ã™(Javaプãƒã‚°ãƒ©ãƒ ã¯ã“ã®2ã¤ã®å‘¼å‡ºã—を区別ã§ãã¾ã›ã‚“)。 .br .br ãŸã¨ãˆã°ã€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª\f2foo\fPã«\f2a.jar\fPã¨\f2b.JAR\fPãŒå«ã¾ã‚Œã¦ã„ã‚‹å ´åˆã€ã‚¯ãƒ©ã‚¹ãƒ»ãƒ‘スè¦ç´ \f2foo/*\fPã¯\f2A.jar:b.JAR\fPã«å±•é–‹ã•ã‚Œã¾ã™ã€‚ãŸã ã—ã€JARファイルã®é †ç•ªã¯æœªæŒ‡å®šã¨ãªã‚Šã¾ã™ã€‚ã“ã®ãƒªã‚¹ãƒˆã«ã¯ã€éš ã—ファイルもå«ã‚ã€æŒ‡å®šã•ã‚ŒãŸãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªå†…ã®ã™ã¹ã¦ã®JARファイルãŒå«ã¾ã‚Œã¾ã™ã€‚\f2*\fPã®ã¿ã‹ã‚‰ãªã‚‹ã‚¯ãƒ©ã‚¹ãƒ»ãƒ‘ス・エントリã¯ã€ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªå†…ã®ã™ã¹ã¦ã®JARファイルã®ãƒªã‚¹ãƒˆã«å±•é–‹ã•ã‚Œã¾ã™ã€‚\f2CLASSPATH\fP環境変数もã€å®šç¾©æ™‚ã«ã¯åŒæ§˜ã«å±•é–‹ã•ã‚Œã¾ã™ã€‚クラス・パスã®ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰å±•é–‹ã¯å¿…ãšã€Java仮想マシンã®èµ·å‹•å‰ã«å®Ÿè¡Œã•ã‚Œã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€ç’°å¢ƒã«å•åˆã›ã‚’è¡Œã‚ãªã„é™ã‚Šã€Javaプãƒã‚°ãƒ©ãƒ ãŒå±•é–‹ã•ã‚Œã¦ã„ãªã„ワイルドカードをèªè˜ã™ã‚‹ã“ã¨ã¯ã‚ã‚Šã¾ã›ã‚“。ãŸã¨ãˆã°ã€\f2System.getenv(\\"CLASSPATH\\")\fP呼出ã—ãŒãã®ä¾‹ã§ã™ã€‚ .TP 3 \-subpackages\ \ package1:package2:... ソース・ファイルã‹ã‚‰æŒ‡å®šã•ã‚ŒãŸãƒ‘ッケージãŠã‚ˆã³ãã®ã‚µãƒ–パッケージ内ã«å†å¸°çš„ã«ãƒ‰ã‚ュメントを生æˆã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã«æ–°ã—ã„ã‚µãƒ–ãƒ‘ãƒƒã‚±ãƒ¼ã‚¸ã‚’è¿½åŠ ã™ã‚‹éš›ã«ä¾¿åˆ©ã§ã™ã€‚æ–°ã—ã„サブパッケージãŒè‡ªå‹•çš„ã«çµ„ã¿è¾¼ã¾ã‚Œã‚‹ã‹ã‚‰ã§ã™ã€‚å„\f2package\fP引数ã¯ã€ä»»æ„ã®æœ€ä¸Šä½ã‚µãƒ–パッケージ(\f2java\fPãªã©)ã¾ãŸã¯å®Œå…¨ä¿®é£¾ãƒ‘ッケージ(\f2javax.swing\fPãªã©)ã«ãªã‚Šã¾ã™ã€‚ソース・ファイルをå«ã‚ã‚‹å¿…è¦ã¯ã‚ã‚Šã¾ã›ã‚“。引数ã¯ã€ã‚³ãƒãƒ³ã§åŒºåˆ‡ã‚‰ã‚Œã¾ã™(ã™ã¹ã¦ã®ã‚ªãƒšãƒ¬ãƒ¼ãƒ†ã‚£ãƒ³ã‚°ãƒ»ã‚·ã‚¹ãƒ†ãƒ )。ワイルドカードã¯ä¸è¦(使用ä¸å¯)ã§ã™ã€‚パッケージã®æ¤œç´¢å ´æ‰€ã‚’指定ã™ã‚‹ã«ã¯ã€\f2\-sourcepath\fPを使用ã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®å‡¦ç†ã§èª¬æ˜Žã—ãŸã¨ãŠã‚Šã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーã«ã‚ã‚‹ãŒãƒ‘ッケージã«ã¯å±žã—ã¦ã„ãªã„ソース・ファイルを処ç†ã—ãªã„ã®ã§å½¹ç«‹ã¡ã¾ã™ã€‚ .br .br 例を示ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax.swing\fP .fl .fi ã“ã®ã‚³ãƒžãƒ³ãƒ‰ã¯ã€ã€Œjavaã€ãŠã‚ˆã³ã€Œjavax.swingã€ã¨ã„ã†åå‰ã®ãƒ‘ッケージã¨ã“れらã®ã‚µãƒ–パッケージ全部ã®ãƒ‰ã‚ュメントを生æˆã—ã¾ã™ã€‚ .br .br \f2\-subpackages\fPã‚’\f2\-exclude\fPã¨çµ„ã¿åˆã›ã¦ä½¿ç”¨ã™ã‚‹ã¨ã€ç‰¹å®šã®ãƒ‘ッケージを除外ã§ãã¾ã™ã€‚ .TP 3 \-exclude\ \ packagename1:packagename2:... 指定ã•ã‚ŒãŸãƒ‘ッケージã¨ãã®ã‚µãƒ–パッケージを\f2\-subpackages\fPã«ã‚ˆã£ã¦ä½œæˆã•ã‚ŒãŸãƒªã‚¹ãƒˆã‹ã‚‰ç„¡æ¡ä»¶ã«é™¤å¤–ã—ã¾ã™ã€‚éŽåŽ»ã¾ãŸã¯å°†æ¥ã®\f2\-subpackages\fPオプションã®æŒ‡å®šã«ã‚ˆã£ã¦çµ„ã¿è¾¼ã¾ã‚Œã‚‹ãƒ‘ッケージも除外ã®å¯¾è±¡ã¨ãªã‚Šã¾ã™ã€‚次ã«ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-sourcepath /home/user/src \-subpackages java \-exclude java.net:java.lang\fP .fl .fi ã“ã®å ´åˆã€\f2java.io\fPã€\f2java.util\fPã€\f2java.math\fPãªã©ã¯çµ„ã¿è¾¼ã¾ã‚Œã¾ã™ãŒã€\f2java.net\fPã¨\f2java.lang\fPをルートã«æŒã¤ãƒ‘ッケージã¯é™¤å¤–ã•ã‚Œã¾ã™ã€‚\f2java.lang\fPã®ã‚µãƒ–パッケージã§ã‚ã‚‹\f2java.lang.ref\fPãŒé™¤å¤–ã•ã‚Œã‚‹ç‚¹ã«æ³¨æ„ã—ã¦ãã ã•ã„。 .TP 3 \-bootclasspath\ classpathlist ブート・クラスãŒå˜åœ¨ã™ã‚‹ãƒ‘スを指定ã—ã¾ã™ã€‚ブート・クラスã¨ã¯ã€é€šå¸¸ã€Javaプラットフォーム・クラスã®ã“ã¨ã§ã™ã€‚ブート・クラスパスã¯ã€JavadocツールãŒã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¨ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’探ã™ã¨ãã«ä½¿ç”¨ã™ã‚‹æ¤œç´¢ãƒ‘スã®ä¸€éƒ¨ã§ã™ã€‚詳細ã¯ã€ .na \f2クラスã®æ¤œç´¢æ–¹æ³•\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/tools/findingclasses.html#srcfilesã‚’å‚ç…§ã—ã¦ãã ã•ã„。\f2classpathlist\fP内ã®è¤‡æ•°ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¯ã€ã‚³ãƒãƒ³(:)ã§åŒºåˆ‡ã‚Šã¾ã™ã€‚ .TP 3 \-extdirs\ dirlist 拡張機能クラスãŒå˜åœ¨ã™ã‚‹ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’指定ã—ã¾ã™ã€‚拡張機能クラスã¨ã¯ã€Java拡張機能機構を使用ã™ã‚‹ã™ã¹ã¦ã®ã‚¯ãƒ©ã‚¹ã§ã™ã€‚extdirsã¯ã€JavadocツールãŒã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¨ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’探ã™ã¨ãã«ä½¿ç”¨ã™ã‚‹æ¤œç´¢ãƒ‘スã®ä¸€éƒ¨ã§ã™ã€‚詳細ã¯ã€å‰è¿°ã®\f2\-classpath\fPã‚’å‚ç…§ã—ã¦ãã ã•ã„。\f2dirlist\fP内ã®è¤‡æ•°ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¯ã€ã‚³ãƒãƒ³(:)ã§åŒºåˆ‡ã‚Šã¾ã™ã€‚ .TP 3 \-verbose Javadocã®å®Ÿè¡Œä¸ã«è©³ç´°ãªãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ã‚’表示ã—ã¾ã™ã€‚verboseオプションを指定ã—ãªã„ã¨ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®ãƒãƒ¼ãƒ‰æ™‚ã€ãƒ‰ã‚ュメントã®ç”Ÿæˆæ™‚(ソース・ファイルã”ã¨ã«1ã¤ã®ãƒ¡ãƒƒã‚»ãƒ¼ã‚¸)ã€ãŠã‚ˆã³ã‚½ãƒ¼ãƒˆæ™‚ã«ãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚verboseオプションを指定ã™ã‚‹ã¨ã€å„Javaソース・ファイルã®è§£æžã«è¦ã—ãŸæ™‚é–“(ミリ秒å˜ä½)を示ã™è¿½åŠ ã®ãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .TP 3 \-quiet エラー・メッセージã¾ãŸã¯è¦å‘Šãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ä»¥å¤–ã®ãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ã‚’抑制ã—ã€è¦å‘Šã¨ã‚¨ãƒ©ãƒ¼ã®ã¿ãŒè¡¨ç¤ºã•ã‚Œã‚‹ã‚ˆã†ã«ã—ã¦ã€ã“れらを確èªã—ã‚„ã™ãã—ã¾ã™ã€‚ãƒãƒ¼ã‚¸ãƒ§ãƒ³æ–‡å—列も抑制ã—ã¾ã™ã€‚ .TP 3 \-breakiterator\ 英文ã®æœ€åˆã®æ–‡ã®çµ‚ã‚りを判æ–ã™ã‚‹éš›ã«ã€è‹±èªžè¨€èªžã¨ã„ã†ãƒã‚±ãƒ¼ãƒ«å›ºæœ‰ã®ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ ã§ã¯ãªã〠.na \f2java.text.BreakIterator\fP @ .fi http://docs.oracle.com/javase/7/docs/api/java/text/BreakIterator.htmlã®å›½éš›åŒ–ã•ã‚ŒãŸæ–‡å¢ƒç•Œã‚’使用ã—ã¾ã™(ä»–ã®ã™ã¹ã¦ã®ãƒã‚±ãƒ¼ãƒ«ã¯ã™ã§ã«\f2BreakIterator\fPを使用)。\f2最åˆã®æ–‡\fPã¨ã¯ã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã¾ãŸã¯ãƒ¡ãƒ³ãƒãƒ¼ã®ä¸»èª¬æ˜Žã§ã®æœ€åˆã®æ–‡ã®ã“ã¨ã§ã™ã€‚ã“ã®æ–‡ã¯ã€ãƒ‘ッケージã€ã‚¯ãƒ©ã‚¹ã€ã¾ãŸã¯ãƒ¡ãƒ³ãƒãƒ¼ã®è¦ç´„ã«ã‚³ãƒ”ーã•ã‚Œã€ã‚¢ãƒ«ãƒ•ã‚¡ãƒ™ãƒƒãƒˆé †ã®ç´¢å¼•ã«ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ .br .br JDK 1.2以é™ã€BreakIteratorクラスã¯ã€è‹±èªžã‚’除ãã™ã¹ã¦ã®è¨€èªžã®æ–‡ã®çµ‚ã‚りを判æ–ã™ã‚‹ãŸã‚ã«ã€ã™ã§ã«ä½¿ç”¨ã•ã‚Œã¦ã„ã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€\f2\-breakiterator\fPオプションã¯ã€1.2以é™ã§ã¯è‹±æ–‡ä»¥å¤–ã«ã¯åŠ¹æžœãŒã‚ã‚Šã¾ã›ã‚“。英文ã«ã¯ã€æ¬¡ã®ã‚ˆã†ãªç‹¬è‡ªã®ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ ãŒã‚ã‚Šã¾ã™ã€‚ .RS 3 .TP 2 o 英文ã®ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®æ–‡åŒºåˆ‡ã‚Šã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ \- 空白文å—ã¾ãŸã¯HTMLブãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°(\f2<P>\fPãªã©)ãŒç¶šãピリオドã§åœæ¢ã—ã¾ã™ã€‚ .TP 2 o breakiterator文区切りアルゴリズム\- 一般ã«ã€æ¬¡ã®èªžãŒå¤§æ–‡å—ã§å§‹ã¾ã‚‹å ´åˆã€ç©ºç™½æ–‡å—ãŒç¶šãピリオドã€ç–‘å•ç¬¦ã€ã¾ãŸã¯æ„Ÿå˜†ç¬¦ã§åœæ¢ã—ã¾ã™ã€‚ã“ã®ã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ ã§ã¯ã€ŒThe serial no. is validã€ãªã©ã€ã»ã¨ã‚“ã©ã®çœç•¥è¡¨è¨˜ãŒå‡¦ç†ã•ã‚Œã¾ã™ãŒã€ã€ŒMr.Smithã€ã¯å‡¦ç†ã•ã‚Œã¾ã›ã‚“。HTMLã‚¿ã‚°ã‚„ã€æ•°å—ã¾ãŸã¯è¨˜å·ã§å§‹ã¾ã‚‹æ–‡ã§ã¯åœæ¢ã—ã¾ã›ã‚“。HTMLã‚¿ã‚°ã«åŸ‹ã‚è¾¼ã¾ã‚Œã¦ã„ã‚‹å ´åˆã§ã‚‚ã€ã€Œ../filenameã€ã®æœ€å¾Œã®ãƒ”リオドã§åœæ¢ã—ã¾ã™ã€‚ .RE 注æ„: 1.5.0ã‹ã‚‰ã¯ã€1.4.xã«è¨ã‘られã¦ã„ãŸbreakiteratorè¦å‘Šãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ã‚’削除ã—ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®æ–‡åŒºåˆ‡ã‚Šã‚¢ãƒ«ã‚´ãƒªã‚ºãƒ を変更ã—ã¦ã„ã¾ã›ã‚“。ã¤ã¾ã‚Šã€\-breakiteratorオプションã¯ã€1.5.0ã§ã¯ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã§ã¯ãªããªã‚Šã€ã¾ãŸãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã«ã™ã‚‹ã¤ã‚‚ã‚Šã‚‚ã‚ã‚Šã¾ã›ã‚“。ã“ã‚Œã¯ã€ã€Œæ¬¡ã®ãƒ¡ã‚¸ãƒ£ãƒ¼ãƒ»ãƒªãƒªãƒ¼ã‚¹ã€(1.5.0)ã§ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã‚’変更ã™ã‚‹ã¨ã„ã†ã€ä»¥å‰ã®ç›®çš„ã¨ã¯é€†ã«ãªã£ã¦ã„ã¾ã™ã€‚ã¤ã¾ã‚Šã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã‚’変更ã›ãšã€1.4.xã§ã®breakiteratorè¦å‘Šã‚’除去ã—ã¦ã„ãªã„å ´åˆã§ã‚‚ã€1.5.0ã‹ã‚‰ã¯ä½•ã‚‚ã™ã‚‹å¿…è¦ãŒãªãã€è¦å‘Šã¯æ¶ˆæ»…ã—ã¦ã„ã¾ã™ã€‚ã“ã®é€†æˆ»ã‚Šã®ç†ç”±ã¯ã€breakiteratorをデフォルトã«ã™ã‚‹ãƒ¡ãƒªãƒƒãƒˆã‚ˆã‚Šã‚‚ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã«ã™ã‚‹ãŸã‚ã«å¿…è¦ã¨ãªã‚‹ã€äº’æ›æ€§ã®ãªã„ソースã®å¤‰æ›´ã®æ–¹ãŒè² æ‹…ãŒå¤§ãã‹ã£ãŸãŸã‚ã§ã™ã€‚ã“ã®ä»¶ã§çš†æ§˜ã«ä½™åˆ†ã®æ‰‹é–“ã‚’ãŠã‹ã‘ã—ã€æ··ä¹±ã‚’æ‹›ã„ãŸã“ã¨ã‚’ãŠè©«ã³ã„ãŸã—ã¾ã™ã€‚ .TP 3 \-locale\ language_country_variant \f3é‡è¦\fP \- \f2\-locale\fPオプションã¯ã€æ¨™æº–ドックレットãŒæä¾›ã™ã‚‹ã™ã¹ã¦ã®ã‚ªãƒ—ションã€ã¾ãŸã¯ãã®ä»–ã®ä»»æ„ã®ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆãŒæä¾›ã™ã‚‹ã™ã¹ã¦ã®ã‚ªãƒ—ションより\f2å‰\fP(å·¦å´)ã«æŒ‡å®šã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ãã†ã—ãªã„ã¨ã€ãƒŠãƒ“ゲーション・ãƒãƒ¼ãŒè‹±èªžã§è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ã“ã®ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ãƒ»ã‚ªãƒ—ションã®ã¿ã€æŒ‡å®šã™ã‚‹é †åºã«ä¾å˜ã—ã¾ã™ã€‚ .br .br JavadocãŒãƒ‰ã‚ュメントを生æˆã™ã‚‹ã¨ãã«ä½¿ç”¨ã™ã‚‹ãƒã‚±ãƒ¼ãƒ«ã‚’指定ã—ã¾ã™ã€‚ã“ã®å¼•æ•°ã¯ã€java.util.Localeã®ãƒ‰ã‚ュメントã§èª¬æ˜Žã•ã‚Œã¦ã„ã‚‹ãƒã‚±ãƒ¼ãƒ«ã®åå‰ã§ã™ã€‚ãŸã¨ãˆã°ã€\f2en_US\fP (英語ã€ç±³å›½)ã¾ãŸã¯\f2en_US_WIN\fP (Windowsã§ä½¿ç”¨ã•ã‚Œã‚‹è‹±èªž)ãªã©ã§ã™ã€‚ .br .br ãƒã‚±ãƒ¼ãƒ«ã‚’指定ã™ã‚‹ã¨ã€æŒ‡å®šã—ãŸãƒã‚±ãƒ¼ãƒ«ã®ãƒªã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒJavadocã«ã‚ˆã£ã¦é¸æŠžã•ã‚Œã¦ã€ãƒ¡ãƒƒã‚»ãƒ¼ã‚¸(ナビゲーション・ãƒãƒ¼ã€ãƒªã‚¹ãƒˆã¨è¡¨ã®è¦‹å‡ºã—ã€ãƒ˜ãƒ«ãƒ—・ファイルã®ç›®æ¬¡ã€stylesheet.cssã®ã‚³ãƒ¡ãƒ³ãƒˆãªã©ã®æ–‡å—列)ã®ãŸã‚ã«ä½¿ç”¨ã•ã‚Œã¾ã™ã€‚ã¾ãŸã€ã‚¢ãƒ«ãƒ•ã‚¡ãƒ™ãƒƒãƒˆé †ã«ã‚½ãƒ¼ãƒˆã•ã‚Œã‚‹ãƒªã‚¹ãƒˆã®ã‚½ãƒ¼ãƒˆé †ã€ãŠã‚ˆã³æœ€åˆã®æ–‡ã®çµ‚ã‚りを判æ–ã™ã‚‹ãŸã‚ã®æ–‡ã®åŒºåˆ‡ã‚Šæ–‡å—ã‚‚ã€æŒ‡å®šã—ãŸãƒã‚±ãƒ¼ãƒ«ã«ã‚ˆã£ã¦æ±ºã¾ã‚Šã¾ã™ã€‚ãŸã ã—ã€ã“ã®ã‚ªãƒ—ションã¯ã€ãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«å†…ã§æŒ‡å®šã•ã‚Œã¦ã„るドã‚ュメンテーション・コメントã®ãƒ†ã‚ストã®ãƒã‚±ãƒ¼ãƒ«ã‚’決定ã™ã‚‹ã‚‚ã®ã§ã¯ã‚ã‚Šã¾ã›ã‚“。 .TP 3 \-encoding\ name ソース・ファイルã®ã‚¨ãƒ³ã‚³ãƒ¼ãƒ‡ã‚£ãƒ³ã‚°ã®åå‰(\f2EUCJIS/SJIS\fPãªã©)を指定ã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションãŒæŒ‡å®šã•ã‚Œã¦ã„ãªã„å ´åˆã¯ã€ãƒ—ラットフォームã®ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆãƒ»ã‚³ãƒ³ãƒãƒ¼ã‚¿ãŒä½¿ç”¨ã•ã‚Œã¾ã™ã€‚ .br .br \-docencodingãŠã‚ˆã³\-charsetã‚‚å‚ç…§ã—ã¦ãã ã•ã„。 .TP 3 \-Jflag Javadocを実行ã™ã‚‹å®Ÿè¡Œæ™‚システムjavaã«ã€\f2flag\fPを直接渡ã—ã¾ã™ã€‚\f2J\fPã¨\f2flag\fPã®é–“ã«ç©ºç™½æ–‡å—を入れãªã„よã†ã«æ³¨æ„ã—ã¦ãã ã•ã„。ãŸã¨ãˆã°ã€ç”Ÿæˆãƒ‰ã‚ュメントを処ç†ã™ã‚‹ãŸã‚ã«ã‚·ã‚¹ãƒ†ãƒ ã§32MBã®ãƒ¡ãƒ¢ãƒªãƒ¼ã‚’確ä¿ã—ã¦ãŠãå¿…è¦ãŒã‚ã‚‹å ´åˆã¯ã€Javaã®\f2\-Xmx\fPオプションを次ã®ã‚ˆã†ã«å‘¼ã³å‡ºã—ã¾ã™(\f2\-Xms\fPã¯çœç•¥å¯èƒ½ã§ã™ã€‚ã“ã‚Œã¯ã€åˆæœŸãƒ¡ãƒ¢ãƒªãƒ¼ã®ã‚µã‚¤ã‚ºã‚’è¨å®šã™ã‚‹ã®ã¿ã®ã‚ªãƒ—ションã§ã€å¿…è¦ãªãƒ¡ãƒ¢ãƒªãƒ¼ã®æœ€å°é‡ãŒã‚ã‹ã£ã¦ã„ã‚‹å ´åˆã«ä¾¿åˆ©ã§ã™)。 .nf \f3 .fl % \fP\f3javadoc \-J\-Xmx32m \-J\-Xms32m\fP \f3com.mypackage\fP .fl .fi 使用ã—ã¦ã„ã‚‹Javadocã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã‚’確èªã™ã‚‹ã«ã¯ã€æ¬¡ã®ã‚ˆã†ã«Javaã®ã€Œ\f2\-version\fPã€ã‚ªãƒ—ションを呼ã³å‡ºã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-J\-version\fP .fl java version "1.2" .fl Classic VM (build JDK\-1.2\-V, green threads, sunwjit) .fl .fi (出力ストリームã«ã¯æ¨™æº–ドックレットã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ãŒå«ã¾ã‚Œã¾ã™ã€‚) .RE .SS 標準ドックレットãŒæä¾›ã™ã‚‹ã‚ªãƒ—ション .RS 3 .TP 3 \-d\ directory 生æˆã•ã‚ŒãŸHTMLファイルをä¿å˜ã™ã‚‹ç”Ÿæˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’指定ã—ã¾ã™ã€‚(「dã€ã¯ã€Œç”Ÿæˆå…ˆ(destination)ã€ã®æ„味。)ã“ã®ã‚ªãƒ—ションをçœç•¥ã™ã‚‹ã¨ã€ãƒ•ã‚¡ã‚¤ãƒ«ã¯ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«ä¿å˜ã•ã‚Œã¾ã™ã€‚値\f2directory\fPã«ã¯ã€çµ¶å¯¾ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã€ã¾ãŸã¯ç¾åœ¨ã®ä½œæ¥ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰ã®ç›¸å¯¾ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’指定ã§ãã¾ã™ã€‚ãƒãƒ¼ã‚¸ãƒ§ãƒ³1.4ã§ã¯ã€Javadocを実行ã™ã‚‹ã¨ç”Ÿæˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªãŒè‡ªå‹•çš„ã«ä½œæˆã•ã‚Œã¾ã™ã€‚ .br .br ãŸã¨ãˆã°ã€æ¬¡ã®ä¾‹ã§ã¯ã€\f2com.mypackage\fPパッケージã®ãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã€ãã®çµæžœãŒ\f2/home/user/doc/\fPディレクトリã«ä¿å˜ã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-d /home/user/doc com.mypackage\fP .fl .fi .TP 3 \-use ドã‚ュメント化ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ãƒ‘ッケージã”ã¨ã«1ã¤ã®ä½¿ç”¨ãƒšãƒ¼ã‚¸ã‚’組ã¿è¾¼ã¿ã¾ã™ã€‚ã“ã®ãƒšãƒ¼ã‚¸ã«ã¯ã€ãã®ç‰¹å®šã®ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ãƒ‘ッケージã®APIを使用ã—ã¦ã„るパッケージã€ã‚¯ãƒ©ã‚¹ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãŠã‚ˆã³ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ãŒè¨˜è¿°ã•ã‚Œã¾ã™ã€‚ãŸã¨ãˆã°ã€ã‚¯ãƒ©ã‚¹Cを例ã«ã¨ã‚‹ã¨ã€ã‚¯ãƒ©ã‚¹Cを使用ã—ã¦ã„ã‚‹ã‚‚ã®ã¨ã—ã¦ã¯ã€Cã®ã‚µãƒ–クラスã€Cã¨ã—ã¦å®£è¨€ã•ã‚Œã¦ã„るフィールドã€Cã‚’è¿”ã™ãƒ¡ã‚½ãƒƒãƒ‰ã€ãŠã‚ˆã³åž‹Cã®ãƒ‘ラメータをæŒã¤ãƒ¡ã‚½ãƒƒãƒ‰ã¨ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ãŒã‚ã‚Šã¾ã™ã€‚ .br .br ãŸã¨ãˆã°ã€Stringã®ä½¿ç”¨ãƒšãƒ¼ã‚¸ã«ä½•ãŒè¡¨ç¤ºã•ã‚Œã‚‹ã‹ã‚’見ã¦ã¿ã¾ã—ょã†ã€‚\f2java.awt.Font\fPクラスã®\f2getName()\fPメソッドã¯ã€\f2String\fPåž‹ã®å€¤ã‚’è¿”ã—ã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€\f2getName()\fPã¯\f2String\fPを使用ã—ã¦ã„ã‚‹ã®ã§ã€\f2String\fPã®ä½¿ç”¨ãƒšãƒ¼ã‚¸ã«ã“ã®ãƒ¡ã‚½ãƒƒãƒ‰ãŒè¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .br .br ãŸã ã—ã€ãƒ‰ã‚ュメント化ã•ã‚Œã‚‹ã®ã¯APIã®ä½¿ç”¨ã®ã¿ã§ã€å®Ÿè£…ã¯ãƒ‰ã‚ュメント化ã•ã‚Œã¾ã›ã‚“。ã‚るメソッドãŒã€ãã®å®Ÿè£…ã®ä¸ã§\f2String\fPを使用ã—ã¦ã„ã¦ã‚‚ã€å¼•æ•°ã¨ã—ã¦æ–‡å—列をã¨ã£ãŸã‚Šã€æ–‡å—列を返ã—ãŸã‚Šã—ãªã„å ´åˆã¯ã€\f2String\fPã®ã€Œä½¿ç”¨ã€ã¨ã¯ã¿ãªã•ã‚Œã¾ã›ã‚“。 .br .br 生æˆã•ã‚ŒãŸä½¿ç”¨ãƒšãƒ¼ã‚¸ã«ã‚¢ã‚¯ã‚»ã‚¹ã™ã‚‹ã«ã¯ã€ã¾ãšç›®çš„ã®ã‚¯ãƒ©ã‚¹ã¾ãŸã¯ãƒ‘ッケージã«ç§»å‹•ã—ã€ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®ã€Œä½¿ç”¨ã€ãƒªãƒ³ã‚¯ã‚’クリックã—ã¾ã™ã€‚ .TP 3 \-version 生æˆãƒ‰ã‚ュメントã«ã€@versionã®ãƒ†ã‚ストを組ã¿è¾¼ã¿ã¾ã™ã€‚ã“ã®ãƒ†ã‚ストã¯ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã§ã¯çœç•¥ã•ã‚Œã¾ã™ã€‚使用ã—ã¦ã„ã‚‹Javadocツールã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã‚’確èªã™ã‚‹ã«ã¯\f2\-J\-version\fPオプションを使用ã—ã¾ã™ã€‚ .TP 3 \-author 生æˆãƒ‰ã‚ュメントã«ã€@authorã®ãƒ†ã‚ストを組ã¿è¾¼ã¿ã¾ã™ã€‚ .TP 3 \-splitindex 索引ファイルをアルファベットã”ã¨ã«è¤‡æ•°ã®ãƒ•ã‚¡ã‚¤ãƒ«ã«åˆ†å‰²ã—ã€æ–‡å—ã”ã¨ã«1ã¤ã®ãƒ•ã‚¡ã‚¤ãƒ«ã¨ã€ã‚¢ãƒ«ãƒ•ã‚¡ãƒ™ãƒƒãƒˆä»¥å¤–ã®æ–‡å—ã§å§‹ã¾ã‚‹ç´¢å¼•ã‚¨ãƒ³ãƒˆãƒªç”¨ã«1ã¤ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆã—ã¾ã™ã€‚ .TP 3 \-windowtitle\ title HTMLã®<title>ã‚¿ã‚°ã«é…ç½®ã™ã‚‹ã‚¿ã‚¤ãƒˆãƒ«ã‚’指定ã—ã¾ã™ã€‚指定ã—ãŸã‚¿ã‚¤ãƒˆãƒ«ã¯ã€ã‚¦ã‚£ãƒ³ãƒ‰ã‚¦ã®ã‚¿ã‚¤ãƒˆãƒ«ã‚„ã€ã“ã®ãƒšãƒ¼ã‚¸ã«å¯¾ã—ã¦ä½œæˆã•ã‚ŒãŸãƒ–ラウザã®ãƒ–ックマーク(ãŠæ°—ã«å…¥ã‚Š)ã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ã“ã®ã‚¿ã‚¤ãƒˆãƒ«ã«ã¯HTMLã‚¿ã‚°ã‚’å«ã‚ãªã„ã§ãã ã•ã„。タイトルã«HTMLã‚¿ã‚°ãŒå«ã¾ã‚Œã¦ã„ã‚‹ã¨ã€ãƒ–ラウザãŒã‚¿ã‚°ã‚’æ£ã—ã解釈ã§ãã¾ã›ã‚“。\f2title\fPã®ä¸ã§å¼•ç”¨ç¬¦ã‚’使用ã™ã‚‹å ´åˆã¯ã€å¼•ç”¨ç¬¦ã‚’エスケープã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\-windowtitleãŒçœç•¥ã•ã‚Œã¦ã„ã‚‹å ´åˆã€Javadocツールã¯ã€ã“ã®ã‚ªãƒ—ションã®ã‹ã‚ã‚Šã«\-doctitleã®å€¤ã‚’使用ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-windowtitle "Java SE Platform" com.mypackage\fP .fl .fi .TP 3 \-doctitle\ title 概è¦ãƒ•ã‚¡ã‚¤ãƒ«ã®æœ€ä¸Šéƒ¨ã®è¿‘ãã«é…ç½®ã™ã‚‹ã‚¿ã‚¤ãƒˆãƒ«ã‚’指定ã—ã¾ã™ã€‚タイトルã¯ä¸å¤®æƒãˆã«ãªã‚Šã€ãƒ¬ãƒ™ãƒ«1ã®è¦‹å‡ºã—ã¨ã—ã¦ã€ä¸Šéƒ¨ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®ã™ã下ã«ç½®ã‹ã‚Œã¾ã™ã€‚\f2title\fPã«ã¯ã€HTMLã‚¿ã‚°ã¨ç©ºç™½ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ãŒã€ã“れらをå«ã‚ã‚‹å ´åˆã¯ã€å…¨ä½“を引用符ã§å›²ã‚€å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\f2title\fPã®ä¸ã§å¼•ç”¨ç¬¦ã‚’使用ã™ã‚‹å ´åˆã¯ã€å¼•ç”¨ç¬¦ã‚’エスケープã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-doctitle "Java(TM)" com.mypackage\fP .fl .fi .TP 3 \-title\ title \f3ã“ã®ã‚ªãƒ—ションã¯ã€ç¾åœ¨ã¯å˜åœ¨ã—ã¦ã„ã¾ã›ã‚“。\fPJavadoc 1.2ã®ãƒ™ãƒ¼ã‚¿ç‰ˆã«ã—ã‹å˜åœ¨ã—ã¦ã„ã¾ã›ã‚“ã§ã—ãŸã€‚ã“ã®ã‚ªãƒ—ションã¯ã€\f2\-doctitle\fPã¨ã„ã†åå‰ã«å¤‰æ›´ã•ã‚Œã¾ã—ãŸã€‚åå‰ã‚’変更ã—ãŸç†ç”±ã¯ã€ã“ã®ã‚ªãƒ—ションãŒã€ã‚¦ã‚£ãƒ³ãƒ‰ã‚¦ã®ã‚¿ã‚¤ãƒˆãƒ«ã§ã¯ãªãドã‚ュメントã®ã‚¿ã‚¤ãƒˆãƒ«ã‚’定義ã™ã‚‹ã“ã¨ã‚’明確ã«ã™ã‚‹ãŸã‚ã§ã™ã€‚ .TP 3 \-header\ header å„出力ファイルã®æœ€ä¸Šéƒ¨ã«é…ç½®ã™ã‚‹ãƒ˜ãƒƒãƒ€ãƒ¼ãƒ»ãƒ†ã‚ストを指定ã—ã¾ã™ã€‚ヘッダーã¯ã€ä¸Šéƒ¨ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®å³å´ã«é…ç½®ã•ã‚Œã¾ã™ã€‚\f2header\fPã«ã¯ã€HTMLã‚¿ã‚°ã¨ç©ºç™½ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ãŒã€ã“れらをå«ã‚ã‚‹å ´åˆã¯ã€å…¨ä½“を引用符ã§å›²ã‚€å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\f2header\fPã®ä¸ã§å¼•ç”¨ç¬¦ã‚’使用ã™ã‚‹å ´åˆã¯ã€å¼•ç”¨ç¬¦ã‚’エスケープã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-header "<b>Java 2 Platform </b><br>v1.4" com.mypackage\fP .fl .fi .TP 3 \-footer\ footer å„出力ファイルã®æœ€ä¸‹éƒ¨ã«é…ç½®ã™ã‚‹ãƒ•ãƒƒã‚¿ãƒ¼ãƒ»ãƒ†ã‚ストを指定ã—ã¾ã™ã€‚フッターã¯ã€ä¸‹éƒ¨ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®å³å´ã«é…ç½®ã•ã‚Œã¾ã™ã€‚\f2footer\fPã«ã¯ã€HTMLã‚¿ã‚°ã¨ç©ºç™½ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ãŒã€ã“れらをå«ã‚ã‚‹å ´åˆã¯ã€å…¨ä½“を引用符ã§å›²ã‚€å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\f2footer\fPã®ä¸ã§å¼•ç”¨ç¬¦ã‚’使用ã™ã‚‹å ´åˆã¯ã€å¼•ç”¨ç¬¦ã‚’エスケープã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .TP 3 \-top å„出力ファイルã®æœ€ä¸Šéƒ¨ã«é…ç½®ã™ã‚‹ãƒ†ã‚ストを指定ã—ã¾ã™ã€‚ .TP 3 \-bottom\ text å„出力ファイルã®æœ€ä¸‹éƒ¨ã«é…ç½®ã™ã‚‹ãƒ†ã‚ストを指定ã—ã¾ã™ã€‚ã“ã®ãƒ†ã‚ストã¯ã€ä¸‹éƒ¨ãƒŠãƒ“ゲーション・ãƒãƒ¼ã‚ˆã‚Šä¸‹ã®ã€ãƒšãƒ¼ã‚¸ã®æœ€ä¸‹éƒ¨ã«é…ç½®ã•ã‚Œã¾ã™ã€‚\f2text\fPã«ã¯ã€HTMLã‚¿ã‚°ã¨ç©ºç™½ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ãŒã€ã“れらをå«ã‚ã‚‹å ´åˆã¯ã€å…¨ä½“を引用符ã§å›²ã‚€å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\f2text\fPã®ä¸ã§å¼•ç”¨ç¬¦ã‚’使用ã™ã‚‹å ´åˆã¯ã€å¼•ç”¨ç¬¦ã‚’エスケープã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .TP 3 \-link\ extdocURL æ—¢å˜ã®Javadocã«ã‚ˆã‚Šç”Ÿæˆã•ã‚ŒãŸå¤–部å‚照クラスã®ãƒ‰ã‚ュメントã¸ã®ãƒªãƒ³ã‚¯ã‚’作æˆã—ã¾ã™ã€‚引数を1ã¤ã¨ã‚Šã¾ã™ã€‚ .RS 3 .TP 2 o \f4extdocURL\fPã¯ã€ãƒªãƒ³ã‚¯å…ˆã¨ã—ã¦æŒ‡å®šã™ã‚‹ã€Javadocã«ã‚ˆã‚Šç”Ÿæˆã•ã‚ŒãŸå¤–部ドã‚ュメントをå«ã‚€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã®çµ¶å¯¾URLã¾ãŸã¯ç›¸å¯¾URLã§ã™ã€‚後ã§ä¾‹ã‚’示ã—ã¾ã™ã€‚ã“ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªå†…ã«package\-listファイルãŒå˜åœ¨ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™(å˜åœ¨ã—ãªã„å ´åˆã¯ã€\f2\-linkoffline\fPを使用ã—ã¾ã™)。Javadocツールã¯ã€\f2package\-list\fPファイルã‹ã‚‰ãƒ‘ッケージåã‚’èªã¿å–ã£ãŸå¾Œã€ãã®URLã§ã“れらã®ãƒ‘ッケージã«ãƒªãƒ³ã‚¯ã—ã¾ã™ã€‚Javadocツールã®å®Ÿè¡Œæ™‚ã«ã€\f2extdocURL\fPã®å€¤ãŒãã®ã¾ã¾ã€ä½œæˆã•ã‚ŒãŸ\f2<A HREF>\fPリンク内ã«ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€\f2extdocURL\fPã¯ãƒ•ã‚¡ã‚¤ãƒ«ã¸ã®URLã§ã¯ãªãã€\f2ディレクトリ\fPã¸ã®URLã§ã‚ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .br .br \f2extdocURL\fPã«çµ¶å¯¾ãƒªãƒ³ã‚¯ã‚’使用ã™ã‚‹ã¨ã€ãƒ¦ãƒ¼ã‚¶ãƒ¼ã®ãƒ‰ã‚ュメントを任æ„ã®Webサイト上ã®ãƒ‰ã‚ュメントã«ãƒªãƒ³ã‚¯ã§ãã¾ã™ã€‚相対ä½ç½®ã¸ãƒªãƒ³ã‚¯ã™ã‚‹ã®ã¿ã®å ´åˆã¯ç›¸å¯¾ãƒªãƒ³ã‚¯ã‚’使用ã§ãã¾ã™ã€‚相対リンクã®å ´åˆã€ãƒ¦ãƒ¼ã‚¶ãƒ¼ãŒæ¸¡ã™å€¤ã¯ã€ç”Ÿæˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª(\f2\-d\fPã§æŒ‡å®š)ã‹ã‚‰ãƒªãƒ³ã‚¯å…ˆã¨ãªã‚‹ãƒ‘ッケージをå«ã‚€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¸ã®ç›¸å¯¾ãƒ‘スã«ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .br .br 通常ã€çµ¶å¯¾ãƒªãƒ³ã‚¯ã‚’指定ã™ã‚‹å ´åˆã¯ã€\f2http:\fPリンクを使用ã—ã¾ã™ã€‚Webサーãƒãƒ¼ã‚’æŒãŸãªã„ファイル・システムã«ãƒªãƒ³ã‚¯ã™ã‚‹å ´åˆã¯ã€\f2file:\fPリンクを使用ã§ãã¾ã™ã€‚ãŸã ã—ã€ã“ã®æ–¹æ³•ã¯ã€åŒã˜ãƒ•ã‚¡ã‚¤ãƒ«ãƒ»ã‚·ã‚¹ãƒ†ãƒ を共有ã™ã‚‹ç”Ÿæˆãƒ‰ã‚ュメントã«ã™ã¹ã¦ã®ãƒ¦ãƒ¼ã‚¶ãƒ¼ãŒã‚¢ã‚¯ã‚»ã‚¹ã™ã‚‹å¿…è¦ãŒã‚ã‚‹å ´åˆä»¥å¤–ã¯ä½¿ç”¨ã—ãªã„ã§ãã ã•ã„。 .br .br ã™ã¹ã¦ã®å ´åˆã€ã™ã¹ã¦ã®ã‚ªãƒšãƒ¬ãƒ¼ãƒ†ã‚£ãƒ³ã‚°ãƒ»ã‚·ã‚¹ãƒ†ãƒ ã§ã€çµ¶å¯¾URLã¨ç›¸å¯¾URLã€ã€Œhttp:ã€ãƒ™ãƒ¼ã‚¹ã¨ã€Œfile:ã€ãƒ™ãƒ¼ã‚¹ã«ã‹ã‹ã‚らãšã€ã‚¹ãƒ©ãƒƒã‚·ãƒ¥ã‚’区切り文å—ã¨ã—ã¦ä½¿ç”¨ã—ã¾ã™( .na \f2URLã®ãƒ‰ã‚ュメント\fP @ .fi http://www.ietf.org/rfc/rfc1738.txtã§æŒ‡å®š)。 .RS 3 .TP 3 http: ベースã®çµ¶å¯¾ãƒªãƒ³ã‚¯: \f2\-link http://<host>/<directory>/<directory>/.../<name>\fP .TP 3 file: ベースã®çµ¶å¯¾ãƒªãƒ³ã‚¯: \f2\-link file://<host>/<directory>/<directory>/.../<name>\fP .TP 3 相対リンク: \f2\-link <directory>/<directory>/.../<name>\fP .RE .RE 1回ã®Javadocã®å®Ÿè¡Œã§ã€è¤‡æ•°ã®\f2\-link\fPオプションを指定ã—ã¦è¤‡æ•°ã®ãƒ‰ã‚ュメントã¸ã®ãƒªãƒ³ã‚¯ã‚’作æˆã§ãã¾ã™ã€‚ .br .br \f3\-linkofflineã¾ãŸã¯\-linkã®é¸æŠž\fP: .br .br \f2\-link\fPを使用ã™ã‚‹å ´åˆ: .RS 3 .TP 2 o 外部APIドã‚ュメントã¸ã®ç›¸å¯¾ãƒ‘スを使用ã™ã‚‹å ´åˆ .TP 2 o 外部APIドã‚ュメントã¸ã®çµ¶å¯¾URLを使用ã™ã‚‹å ´åˆ(プãƒã‚°ãƒ©ãƒ ãŒãã®URLã«æŽ¥ç¶šã—ã€èªå–ã‚Šã‚’è¡Œã†ã“ã¨ãŒã‚·ã‚§ãƒ«ã«ã‚ˆã£ã¦è¨±å¯ã•ã‚Œã¦ã„ã‚‹å ´åˆ) .RE \f2\-linkoffline\fPを使用ã™ã‚‹å ´åˆ: .RS 3 .TP 2 o 外部APIドã‚ュメントã¸ã®çµ¶å¯¾URLを使用ã™ã‚‹å ´åˆ(プãƒã‚°ãƒ©ãƒ ãŒãã®URLã«æŽ¥ç¶šã—ã€èªå–ã‚Šã‚’è¡Œã†ã“ã¨ãŒã‚·ã‚§ãƒ«ã«ã‚ˆã£ã¦\f2許å¯ã•ã‚Œã¦ã„ãªã„\fPå ´åˆ)ã“ã®ã‚ˆã†ãªçŠ¶æ³ã¯ã€ãƒ•ã‚¡ã‚¤ã‚¢ã‚¦ã‚©ãƒ¼ãƒ«ã®å†…å´ã‹ã‚‰ãƒ•ã‚¡ã‚¤ã‚¢ã‚¦ã‚©ãƒ¼ãƒ«ã®å¤–å´ã«ã‚るドã‚ュメントã«ãƒªãƒ³ã‚¯ã—よã†ã¨ã™ã‚‹å ´åˆã«ç™ºç”Ÿã—ã¾ã™ã€‚ .RE .br .br \f3外部ドã‚ュメントã¸ã®çµ¶å¯¾ãƒªãƒ³ã‚¯ã®ä½¿ç”¨ä¾‹\fP \- .na \f2http://docs.oracle.com/javase/7/docs/api/\fP @ .fi http://docs.oracle.com/javase/7/docs/api/内ã®\f2java.lang\fPã€\f2java.io\fPã€ãã®ä»–ã®Javaプラットフォーム・パッケージã«ãƒªãƒ³ã‚¯ã—ãŸã„ã¨ã—ã¾ã™ã€‚次ã®ã‚³ãƒžãƒ³ãƒ‰ã¯ã€Java SEプラットフォーム・パッケージã¸ã®ãƒªãƒ³ã‚¯æŒã¤\f2com.mypackage\fPパッケージã®ãƒ‰ã‚ュメントを生æˆã—ã¾ã™ã€‚生æˆãƒ‰ã‚ュメントã«ã¯ã€ãŸã¨ãˆã°ã‚¯ãƒ©ã‚¹ãƒ»ãƒ„リー内ã®\f2Object\fPクラスã¸ã®ãƒªãƒ³ã‚¯ãŒå«ã¾ã‚Œã¦ã„ã¾ã™ã€‚(\f2\-sourcepath\fPã‚„\f2\-d\fPãªã©ã®ä»–ã®ã‚ªãƒ—ションã¯è¡¨ç¤ºã•ã‚Œã¾ã›ã‚“。) .nf \f3 .fl % \fP\f3javadoc \-link http://docs.oracle.com/javase/7/docs/api/ com.mypackage\fP .fl .fi \f3外部ドã‚ュメントã¸ã®ç›¸å¯¾ãƒªãƒ³ã‚¯ã®ä½¿ç”¨ä¾‹\fP \- 2ã¤ã®ãƒ‘ッケージãŒã‚ã‚Šã€ãã®ãƒ‰ã‚ュメントãŒJavadocツールを複数回実行ã—ãŸçµæžœç”Ÿæˆã•ã‚ŒãŸã‚‚ã®ã§ã‚ã‚‹ã¨ã—ã¾ã™ã€‚ã•ã‚‰ã«ã€ã“れらã®ãƒ‰ã‚ュメントãŒç›¸å¯¾ãƒ‘スã§åˆ†å‰²ã•ã‚Œã¦ã„ã‚‹ã¨ã—ã¾ã™ã€‚ã“ã®ä¾‹ã®å ´åˆã€ãƒ‘ッケージã¯ã€APIã§ã‚ã‚‹\f2com.apipackage\fPã¨ã€SPI(サービス・プãƒãƒã‚¤ãƒ€ãƒ»ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹)ã§ã‚ã‚‹\f2com.spipackage\fPã§ã™ã€‚ドã‚ュメントã®æ ¼ç´å…ˆã¯ã€\f2docs/api/com/apipackage\fPã¨\f2docs/spi/com/spipackage\fPã§ã™ã€‚APIパッケージã®ãƒ‰ã‚ュメントã¯ã™ã§ã«ç”Ÿæˆã•ã‚Œã¦ã„ã¦ã€\f2docs\fPãŒç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã§ã‚ã‚‹å ´åˆã€APIドã‚ュメントã¸ã®ãƒªãƒ³ã‚¯ã‚’æŒã¤SPIパッケージをドã‚ュメント化ã™ã‚‹ã«ã¯ã€æ¬¡ã®ã‚³ãƒžãƒ³ãƒ‰ã‚’実行ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-d ./spi \-link ../api com.spipackage\fP .fl .fi \f2\-link\fPã®å¼•æ•°ã¯ã€å®›å…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª(\f2docs/spi\fP)ã‹ã‚‰ã®ç›¸å¯¾ãƒ‘スã§ã™ã€‚ .br .br \f3詳細\fP \- \f2\-link\fPオプションを使用ã™ã‚‹ã¨ã€ã‚³ãƒ¼ãƒ‰ã‹ã‚‰ã¯å‚ç…§ã•ã‚Œã¦ã„ã¦ã‚‚ã€ä»Šå›žã®Javadocã®å®Ÿè¡Œã§ã¯ãƒ‰ã‚ュメント化\f2ã•ã‚Œãªã„\fPã¨ã„ã†ã‚¯ãƒ©ã‚¹ã«ãƒªãƒ³ã‚¯ã§ãるよã†ã«ãªã‚Šã¾ã™ã€‚リンクã‹ã‚‰æœ‰åŠ¹ãªãƒšãƒ¼ã‚¸ã«ç§»å‹•ã§ãるよã†ã«ã™ã‚‹ã«ã¯ã€ãれらã®HTMLページãŒã‚ã‚‹å ´æ‰€ã‚’èª¿ã¹ã€ãã®å ´æ‰€ã‚’\f2extdocURL\fPã«æŒ‡å®šã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€ãŸã¨ãˆã°ã€ã‚µãƒ¼ãƒ‰ãƒ»ãƒ‘ーティã®ãƒ‰ã‚ュメントã‹ã‚‰\f2http://docs.oracle.com\fP上ã®\f2java.*\fPã®ãƒ‰ã‚ュメントã«ãƒªãƒ³ã‚¯ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ .br .br 今回ã®å®Ÿè¡Œã§Javadocã«ã‚ˆã£ã¦ç”Ÿæˆã•ã‚Œã‚‹ãƒ‰ã‚ュメント内ã®APIã®ã¿ã‚’対象ã«ãƒªãƒ³ã‚¯ã‚’作æˆã™ã‚‹å ´åˆã¯ã€\f2\-link\fPオプションをçœç•¥ã—ã¾ã™ã€‚(\f2\-link\fPオプションãŒæŒ‡å®šã•ã‚Œã¦ã„ãªã„ã¨ã€Javadocツールã¯ã€å¤–部å‚ç…§ã®ãƒ‰ã‚ュメントã¸ã®ãƒªãƒ³ã‚¯ã‚’作æˆã—ã¾ã›ã‚“。ã“ã‚Œã¯ã€ãã®ãƒ‰ã‚ュメントãŒå˜åœ¨ã™ã‚‹ã‹ã©ã†ã‹ã€ãŠã‚ˆã³å˜åœ¨ã™ã‚‹å ´åˆã¯ãã®å ´æ‰€ãŒã‚ã‹ã‚‰ãªã„ã‹ã‚‰ã§ã™ã€‚) .br .br ã“ã®ã‚ªãƒ—ションã§ã¯ã€ç”Ÿæˆãƒ‰ã‚ュメント内ã®è¤‡æ•°ã®å ´æ‰€ã«ãƒªãƒ³ã‚¯ã‚’作æˆã§ãã¾ã™ã€‚ .br .br ã‚‚ã†1ã¤ã®ç”¨é€”ã¯ã€ãƒ‘ッケージ・セットã®é–“ã«ã‚¯ãƒã‚¹ãƒªãƒ³ã‚¯ã‚’作æˆã™ã‚‹ã“ã¨ã§ã™ã€‚一方ã®ãƒ‘ッケージ・セットã«å¯¾ã—ã¦Javadocを実行ã—ãŸå¾Œã€ä»–æ–¹ã®ãƒ‘ッケージ・セットã«å¯¾ã—ã¦Javadocã‚’å†åº¦å®Ÿè¡Œã™ã‚‹ã¨ã€ä¸¡ã‚»ãƒƒãƒˆé–“ã«åŒæ–¹å‘ã®ãƒªãƒ³ã‚¯ã‚’作æˆã§ãã¾ã™ã€‚ .br .br \f3クラスã®å‚照方法\fP \- 外部å‚照クラスã¸ã®ãƒªãƒ³ã‚¯ã‚’ã€ãƒ†ã‚スト・ラベルã®ã¿ã§ã¯ãªã実際ã«è¡¨ç¤ºã™ã‚‹ã«ã¯ã€æ¬¡ã®æ–¹æ³•ã§ã‚¯ãƒ©ã‚¹ã‚’å‚ç…§ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚メソッドã®æœ¬ä½“ã§ã‚¯ãƒ©ã‚¹ã‚’å‚ç…§ã™ã‚‹ã®ã¿ã§ã¯å分ã§ã¯ã‚ã‚Šã¾ã›ã‚“。\f2import\fPæ–‡ã€å®£è¨€ã®ã„ãšã‚Œã‹ã§å‚ç…§ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚次ã«ã€ã‚¯ãƒ©ã‚¹\f2java.io.File\fPã‚’å‚ç…§ã™ã‚‹æ–¹æ³•ã®ä¾‹ã‚’示ã—ã¾ã™ã€‚ .RS 3 .TP 2 o ã™ã¹ã¦ã®ã‚¿ã‚¤ãƒ—ã®\f2import\fPæ–‡ã®å ´åˆ: ワイルドカードã«ã‚ˆã‚‹ã‚¤ãƒ³ãƒãƒ¼ãƒˆã€åå‰ã«ã‚ˆã‚‹æ˜Žç¤ºçš„ãªã‚¤ãƒ³ãƒãƒ¼ãƒˆã€ã¾ãŸã¯\f2java.lang.*\fPã«å¯¾ã™ã‚‹è‡ªå‹•ã‚¤ãƒ³ãƒãƒ¼ãƒˆã€‚ãŸã¨ãˆã°ã€æ¬¡ã®ã‚ˆã†ã«ã™ã‚Œã°å分ã§ã™ã€‚ .br \f2import java.io.*;\fP .br 1.3.xãŠã‚ˆã³1.2.xã§ã¯ã€åå‰ã«ã‚ˆã‚‹æ˜Žç¤ºçš„ãªã‚¤ãƒ³ãƒãƒ¼ãƒˆã®ã¿æ©Ÿèƒ½ã—ã¾ã™ã€‚ワイルドカードã«ã‚ˆã‚‹ã‚¤ãƒ³ãƒãƒ¼ãƒˆæ–‡ã‚‚ã€\f2java.lang.*\fPã®è‡ªå‹•ã‚¤ãƒ³ãƒãƒ¼ãƒˆã‚‚機能ã—ã¾ã›ã‚“。 .TP 2 o 宣言ã®å ´åˆ: .br \f2void foo(File f){}\fP .br ã“ã®å‚照を使用ã—ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã€ã‚¯ãƒ©ã‚¹ã€ã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®æˆ»ã‚Šå€¤ã®åž‹ã¾ãŸã¯ãƒ‘ラメータã®åž‹ã«ç½®ãã‹ã€\f2implements\fPã€\f2extends\fPã€ã¾ãŸã¯\f2throws\fPæ–‡ã«ç½®ãã¾ã™ã€‚ .RE é‡è¦ãªçµæžœã¨ã—ã¦ã€\f2\-link\fPオプションを使用ã—ã¦ã‚‚ã€ã“ã®åˆ¶é™ã®ãŸã‚ã«èª¤ã£ã¦è¡¨ç¤ºã•ã‚Œãªã„リンクãŒå¤šæ•°ç™ºç”Ÿã™ã‚‹å¯èƒ½æ€§ãŒã‚ã‚Šã¾ã™ã€‚(テã‚ストã¯ãƒã‚¤ãƒ‘ーテã‚スト・リンクãŒä»˜ã‘られãšã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚)リンクãŒè¡¨ç¤ºã™ã‚‹è¦å‘Šã‹ã‚‰ã€ã“れらã®ãƒªãƒ³ã‚¯ã‚’èªè˜ã§ãã¾ã™ã€‚クラスをæ£ã—ãå‚ç…§ã—ã€ãã‚Œã«ã‚ˆã£ã¦ãƒªãƒ³ã‚¯ã‚’è¿½åŠ ã™ã‚‹ãŸã‚ã®æœ€ã‚‚安全ãªæ–¹æ³•ã¯å‰è¿°ã—ãŸã¨ãŠã‚Šã€ãã®ã‚¯ãƒ©ã‚¹ã‚’インãƒãƒ¼ãƒˆã™ã‚‹ã“ã¨ã§ã™ã€‚ .br .br \f3パッケージ・リスト\fP \- \f2\-link\fPオプションã«ã¯ã€Javadocツールã«ã‚ˆã£ã¦ç”Ÿæˆã•ã‚Œã‚‹\f2package\-list\fPã¨ã„ã†åå‰ã®ãƒ•ã‚¡ã‚¤ãƒ«ãŒã€\f2\-link\fPã«æŒ‡å®šã—ãŸURLã«å˜åœ¨ã—ã¦ã„ã‚‹ã“ã¨ãŒå¿…è¦ã§ã™ã€‚\f2package\-list\fPファイルã¯ã€ãã®å ´æ‰€ã«ã‚るドã‚ュメント化ã•ã‚ŒãŸãƒ‘ッケージã®åå‰ã®ãƒªã‚¹ãƒˆãŒå…¥ã£ãŸå˜ç´”ãªãƒ†ã‚スト・ファイルã§ã™ã€‚å‰ã®ä¾‹ã§ã¯ã€Javadocツールã¯ã€æŒ‡å®šã•ã‚ŒãŸURLã§\f2package\-list\fPã¨ã„ã†åå‰ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’探ã—ã€ãƒ‘ッケージåã‚’èªã¿è¾¼ã‚“ã 後ã€ãã®URLã«ã‚ã‚‹ãれらã®ãƒ‘ッケージã¸ã®ãƒªãƒ³ã‚¯ã‚’作æˆã—ã¾ã—ãŸã€‚ .br .br ãŸã¨ãˆã°ã€Java SE 6 APIã®ãƒ‘ッケージ・リスト㯠.na \f2http://docs.oracle.com/javase/7/docs/api/package\-list\fP @ .fi http://docs.oracle.com/javase/7/docs/api/package\-listã«ã‚ã‚Šã€æ¬¡ã®ã‚ˆã†ãªå†…容ã§å§‹ã¾ã£ã¦ã„ã¾ã™ã€‚ .nf \f3 .fl java.applet .fl java.awt .fl java.awt.color .fl java.awt.datatransfer .fl java.awt.dnd .fl java.awt.event .fl java.awt.font .fl etc. .fl \fP .fi \f2\-link\fPオプションを指定ã›ãšã«Javadocを実行ã—ãŸå ´åˆã€Javadocã¯å¤–部å‚照クラスã«å±žã™ã‚‹åå‰ã‚’見ã¤ã‘ã‚‹ã¨ã€ãã®åå‰ã‚’リンクãªã—ã§å‡ºåŠ›ã—ã¾ã™ã€‚一方ã€\f2\-link\fPオプションを指定ã—ãŸå ´åˆã€Javadocツールã¯ã€æŒ‡å®šã•ã‚ŒãŸ\f2extdocURL\fPã®å ´æ‰€ã«ã‚ã‚‹\f2package\-list\fPファイルã§ãã®ãƒ‘ッケージåを検索ã—ã¾ã™ã€‚パッケージåãŒè¦‹ã¤ã‹ã‚‹ã¨ã€\f2extdocURL\fPãŒåå‰ã®å‰ã«ä»˜åŠ ã•ã‚Œã¾ã™ã€‚ .br .br ã™ã¹ã¦ã®ãƒªãƒ³ã‚¯ãŒæ£ã—ã機能ã™ã‚‹ãŸã‚ã«ã¯ã€å¤–部å‚ç…§ã®ã™ã¹ã¦ã®ãƒ‰ã‚ュメントãŒã€æŒ‡å®šã—ãŸURLã«å˜åœ¨ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚Javadocツールã¯ã€æŒ‡å®šã•ã‚ŒãŸpackage\-listãŒå˜åœ¨ã™ã‚‹ã‹ã©ã†ã‹ã®ã¿ã‚’ãƒã‚§ãƒƒã‚¯ã—ã€ã“れらã®ãƒšãƒ¼ã‚¸ãŒå˜åœ¨ã™ã‚‹ã‹ã©ã†ã‹ã¯ãƒã‚§ãƒƒã‚¯ã—ã¾ã›ã‚“。 .br .br \f3複数ã®ãƒªãƒ³ã‚¯\fP \- 複数ã®\f2\-link\fPオプションを指定ã™ã‚‹ã¨ã€ä»»æ„ã®æ•°ã®å¤–部生æˆãƒ‰ã‚ュメントã¸ã®ãƒªãƒ³ã‚¯ã‚’作æˆã§ãã¾ã™ã€‚\ Javadoc 1.2ã«ã¯ã€è¤‡æ•°ã®\f2\-link\fPコマンドを指定ã§ããªã„ã¨ã„ã†æ—¢çŸ¥ã®ãƒã‚°ãŒã‚ã‚Šã¾ã™ã€‚ã“ã‚Œã¯1.2.2ã§ä¿®æ£ã•ã‚Œã¾ã—ãŸã€‚ .br .br リンクã™ã‚‹å¤–部ドã‚ュメントã”ã¨ã«ã€æ¬¡ã®ã‚ˆã†ã«åˆ¥ã€…ã®ãƒªãƒ³ã‚¯ãƒ»ã‚ªãƒ—ションを指定ã—ã¾ã™ã€‚ .br .br \ \ \f2% \fP\f4javadoc \-link\fP \f2extdocURL1\fP \f4\-link\fP \f2extdocURL2\fP \f2... \fP\f4\-link\fP \f2extdocURLn\fP \f4com.mypackage\fP .br .br \f2extdocURL1\fPã€\ \f2extdocURL2\fPã€\ ... \f2extdocURLn\fPã¯ã€ãã‚Œãžã‚Œå¤–部ドã‚ュメントã®ãƒ«ãƒ¼ãƒˆã‚’指ã—ã€å„ルートã«ã¯ã€\f2package\-list\fPã¨ã„ã†åå‰ã®ãƒ•ã‚¡ã‚¤ãƒ«ãŒå…¥ã£ã¦ã„ã¾ã™ã€‚ .br .br \f3クãƒã‚¹ãƒªãƒ³ã‚¯\fP \- ã¾ã 生æˆã•ã‚Œã¦ã„ãªã„2ã¤ä»¥ä¸Šã®ãƒ‰ã‚ュメントをクãƒã‚¹ãƒªãƒ³ã‚¯ã™ã‚‹å ´åˆã¯ã€ã€Œãƒ–ートストラップã€ãŒå¿…è¦ã«ãªã‚Šã¾ã™ã€‚ã¤ã¾ã‚Šã€ã©ã®ãƒ‰ã‚ュメントã«ã¤ã„ã¦ã‚‚\f2package\-list\fPãŒå˜åœ¨ã—ã¦ã„ãªã„å ´åˆã¯ã€æœ€åˆã®ãƒ‰ã‚ュメントã«å¯¾ã—ã¦Javadocツールを実行ã™ã‚‹æ™‚点ã§ã€2番目ã®ãƒ‰ã‚ュメントã®\f2package\-list\fPã¯ã¾ã å˜åœ¨ã—ã¦ã„ã¾ã›ã‚“。ã—ãŸãŒã£ã¦ã€å¤–部リンクを作æˆã™ã‚‹ã«ã¯ã€2番目ã®ãƒ‰ã‚ュメントを生æˆã—ãŸå¾Œã§ã€æœ€åˆã®ãƒ‰ã‚ュメントを生æˆã—ç›´ã™å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .br .br ã“ã®å ´åˆã€æœ€åˆã®ãƒ‰ã‚ュメント生æˆã®ç›®çš„ã¯ã€\f2package\-list\fPを作æˆã™ã‚‹ã“ã¨ã§ã™(パッケージåを把æ¡ã—ã¦ã„ã‚‹å ´åˆã¯æ‰‹å‹•ã§ä½œæˆã—ã¦ã‚‚ã‹ã¾ã„ã¾ã›ã‚“)。次ã«ã€2番目ã®ãƒ‰ã‚ュメントã¨ãã®å¤–部リンクを生æˆã—ã¾ã™ã€‚å¿…è¦ãªå¤–部ã®\f2package\-list\fPファイルãŒå˜åœ¨ã—ãªã„å ´åˆã¯ã€Javadocツールã‹ã‚‰è¦å‘ŠãŒå‡ºåŠ›ã•ã‚Œã¾ã™ã€‚ .TP 3 \-linkoffline\ extdocURL\ packagelistLoc ã“ã®ã‚ªãƒ—ションã¯\f2\-link\fPã®ãƒãƒªã‚¨ãƒ¼ã‚·ãƒ§ãƒ³ã®1ã¤ã§ã™ã€‚ã©ã¡ã‚‰ã‚‚ã€Javadocã«ã‚ˆã‚Šç”Ÿæˆã•ã‚ŒãŸå¤–部å‚照クラスã®ãƒ‰ã‚ュメントã¸ã®ãƒªãƒ³ã‚¯ã‚’作æˆã—ã¾ã™ã€‚Javadocツール自体ãŒã€Œã‚ªãƒ•ãƒ©ã‚¤ãƒ³ã€ã«ãªã£ã¦ã„ã‚‹ã¨ã(Web接続を使用ã—ã¦ãƒ‰ã‚ュメントã«ã‚¢ã‚¯ã‚»ã‚¹ã§ããªã„ã¨ã)ã€Web上ã®ãƒ‰ã‚ュメントã«ãƒªãƒ³ã‚¯ã™ã‚‹ã«ã¯ã€\f2\-linkoffline\fPオプションを使用ã—ã¾ã™ã€‚ .br .br 厳密ã«ã¯ã€å¤–部ドã‚ュメントã®\f2package\-list\fPファイルã«ã‚¢ã‚¯ã‚»ã‚¹ã§ããªã„ã¨ãã€ã¾ãŸã¯ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ãŒ\f2extdocURL\fPã§æŒ‡å®šã•ã‚ŒãŸå ´æ‰€ã«ã¯å˜åœ¨ã›ãšã€\f2packageListLoc\fPã§æŒ‡å®šã§ãる別ã®å ´æ‰€(通常ãƒãƒ¼ã‚«ãƒ«)ã«å˜åœ¨ã™ã‚‹ã¨ãã€\f2\-linkoffline\fPを使用ã—ã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€\f2extdocURL\fPã«WWW上ã§ã—ã‹ã‚¢ã‚¯ã‚»ã‚¹ã§ããªã„å ´åˆã¯ã€\f2\-linkoffline\fPを指定ã™ã‚‹ã“ã¨ã«ã‚ˆã‚Šã€ãƒ‰ã‚ュメントã®ç”Ÿæˆæ™‚ã«JavadocツールãŒWebã«æŽ¥ç¶šã§ãã‚‹å¿…è¦ãŒã‚ã‚‹ã¨ã„ã†åˆ¶ç´„ãŒãªããªã‚Šã¾ã™ã€‚ .br .br ã‚‚ã†1ã¤ã®ç”¨é€”ã¯ã€ãƒ‰ã‚ュメントを更新ã™ã‚‹ãŸã‚ã®ã€Œãƒãƒƒã‚ングã€ã¨ã—ã¦ä½¿ç”¨ã™ã‚‹ã“ã¨ã§ã™ã€‚パッケージã®ã‚»ãƒƒãƒˆå…¨ä½“ã«å¯¾ã—ã¦Javadocを実行ã—ãŸå¾Œã€å¤‰æ›´ã—ãŸä¸€éƒ¨ã®ãƒ‘ッケージã«å¯¾ã—ã¦ã®ã¿Javadocã‚’å†åº¦å®Ÿè¡Œã—ã¦ã€æ›´æ–°ã•ã‚ŒãŸãƒ•ã‚¡ã‚¤ãƒ«ã‚’ã€ã‚ªãƒªã‚¸ãƒŠãƒ«ã®ã‚»ãƒƒãƒˆã«æŒ¿å…¥ã§ãるよã†ã«ã—ã¾ã™ã€‚後ã§ä¾‹ã‚’示ã—ã¾ã™ã€‚ .br .br \f2\-linkoffline\fPオプションã¯å¼•æ•°ã‚’2ã¤å–ã‚Šã¾ã™ã€‚第1引数ã¯\f2<a href>\fPリンクã«çµ„ã¿è¾¼ã¾ã‚Œã‚‹æ–‡å—列を指定ã™ã‚‹å¼•æ•°ã€ç¬¬2引数ã¯\f2package\-list\fPã®æ¤œç´¢å ´æ‰€ã‚’指定ã™ã‚‹å¼•æ•°ã§ã™ã€‚ .RS 3 .TP 2 o \f4extdocURL\fPã¯ã€ãƒªãƒ³ã‚¯å…ˆã¨ã—ã¦æŒ‡å®šã™ã‚‹ã€Javadocã«ã‚ˆã‚Šç”Ÿæˆã•ã‚ŒãŸå¤–部ドã‚ュメントをå«ã‚€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã®çµ¶å¯¾URLã¾ãŸã¯ç›¸å¯¾URLã§ã™ã€‚相対URLã®å ´åˆã€å€¤ã¯ã€ç”Ÿæˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª(\f2\-d\fPã§æŒ‡å®š)ã‹ã‚‰ãƒªãƒ³ã‚¯å…ˆã¨ãªã‚‹ãƒ‘ッケージã®ãƒ«ãƒ¼ãƒˆã¸ã®ç›¸å¯¾ãƒ‘スã«ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚詳細ã¯ã€\f2\-link\fPオプションã®\f2extdocURL\fPã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .TP 2 o \f4packagelistLoc\fPã¯ã€å¤–部ドã‚ュメントã®\f2package\-list\fPファイルをå«ã‚€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¸ã®ãƒ‘スã¾ãŸã¯URLã§ã™ã€‚ã“ã‚Œã¯ã€URL (http:ã¾ãŸã¯file:)ã§ã‚‚ファイル・パスã§ã‚‚ã‹ã¾ã„ã¾ã›ã‚“。ã¾ãŸã€çµ¶å¯¾ãƒ‘スã¨ç›¸å¯¾ãƒ‘スã®ã©ã¡ã‚‰ã§ã‚‚ã‹ã¾ã„ã¾ã›ã‚“。相対パスã®å ´åˆã¯ã€javadocãŒå®Ÿè¡Œã•ã‚Œã‚‹\f2ç¾åœ¨ã®\fPディレクトリã‹ã‚‰ã®ç›¸å¯¾ãƒ‘スã¨ã—ã¦æŒ‡å®šã—ã¾ã™ã€‚ファイルåã®\f2package\-list\fPã¯å«ã‚ãªã„ã§ãã ã•ã„。 .RE 1回ã®Javadocã®å®Ÿè¡Œã§ã€è¤‡æ•°ã®\f2\-linkoffline\fPオプションを指定ã§ãã¾ã™ã€‚(1.2.2よりå‰ã¯ã€1ã¤ã®ã‚ªãƒ—ションã—ã‹æŒ‡å®šã§ãã¾ã›ã‚“ã§ã—ãŸã€‚) .br .br \f3外部ドã‚ュメントã¸ã®çµ¶å¯¾ãƒªãƒ³ã‚¯ã®ä½¿ç”¨ä¾‹\fP \- \f2http://docs.oracle.com/javase/7/docs/api/\fP内ã®\f2java.lang\fPã€\f2java.io\fPã€ãã®ä»–ã®Java SEプラットフォーム・パッケージã«ãƒªãƒ³ã‚¯ã—ãŸã„ãŒã€Webã«ã‚¢ã‚¯ã‚»ã‚¹ã§ããªã„ã¨ã—ã¾ã™ã€‚ブラウザã§ã€ .na \f2http://docs.oracle.com/javase/7/docs/api/package\-list\fP @ .fi http://docs.oracle.com/javase/7/docs/api/package\-listã«ã‚ã‚‹\f2package\-list\fPファイルを開ãã€ãれをãƒãƒ¼ã‚«ãƒ«ãƒ»ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«ä¿å˜ã—ã€ç¬¬2引数\f2packagelistLoc\fPã§ã“ã®ãƒãƒ¼ã‚«ãƒ«ãƒ»ã‚³ãƒ”ーã®å ´æ‰€ã‚’指定ã—ã¾ã™ã€‚ã“ã®ä¾‹ã§ã¯ã€ãƒ‘ッケージ・リスト・ファイルã¯ã‚«ãƒ¬ãƒ³ãƒˆãƒ»ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã€Œ\f2.\fPã€ã«ä¿å˜ã•ã‚Œã¦ã„ã¾ã™ã€‚次ã®ã‚³ãƒžãƒ³ãƒ‰ã¯ã€Java SEプラットフォーム・パッケージã¸ã®ãƒªãƒ³ã‚¯æŒã¤\f2com.mypackage\fPパッケージã®ãƒ‰ã‚ュメントを生æˆã—ã¾ã™ã€‚生æˆãƒ‰ã‚ュメントã«ã¯ã€ãŸã¨ãˆã°ã‚¯ãƒ©ã‚¹ãƒ»ãƒ„リー内ã®\f2Object\fPクラスã¸ã®ãƒªãƒ³ã‚¯ãŒå«ã¾ã‚Œã¦ã„ã¾ã™ã€‚(\f2\-sourcepath\fPãªã©ã€ä»–ã®å¿…è¦ãªã‚ªãƒ—ションã¯è¡¨ç¤ºã•ã‚Œã¾ã›ã‚“。) .nf \f3 .fl % \fP\f3javadoc \-linkoffline http://docs.oracle.com/javase/7/docs/api/ . com.mypackage\fP .fl .fi \f3外部ドã‚ュメントã¸ã®ç›¸å¯¾ãƒªãƒ³ã‚¯ã®ä½¿ç”¨ä¾‹\fP \- \f2\-linkoffline\fPを相対パスã¨ã¨ã‚‚ã«ä½¿ç”¨ã™ã‚‹ã“ã¨ã¯ã‚ã¾ã‚Šã‚ã‚Šã¾ã›ã‚“。ç†ç”±ã¯å˜ç´”ã§ã€é€šå¸¸ã¯\f2\-link\fPã§é–“ã«åˆã†ã‹ã‚‰ã§ã™ã€‚\f2\-linkoffline\fPを使用ã™ã‚‹éš›ã€\f2package\-list\fPã«ã¯é€šå¸¸ãƒãƒ¼ã‚«ãƒ«ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’指定ã—ã¾ã™ã€‚相対リンクを使用ã™ã‚‹éš›ã‚‚ã€ãƒªãƒ³ã‚¯å…ˆã®ãƒ•ã‚¡ã‚¤ãƒ«ã«ã¯é€šå¸¸ãƒãƒ¼ã‚«ãƒ«ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’指定ã—ã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€\f2\-linkoffline\fPã®2ã¤ã®å¼•æ•°ã«åˆ¥ã€…ã®ãƒ‘スを指定ã™ã‚‹å¿…è¦ã¯é€šå¸¸ã‚ã‚Šã¾ã›ã‚“。2ã¤ã®å¼•æ•°ãŒåŒä¸€ã§ã‚ã‚‹å ´åˆã¯ã€\f2\-link\fPを使用ã§ãã¾ã™ã€‚\f2\-link\fPã®ç›¸å¯¾ãƒªãƒ³ã‚¯ã®ä¾‹ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .br .br \f4package\-list\fP\f3ファイルを手動ã§ä½œæˆ\fP \- \f2package\-list\fPファイルãŒã¾ã å˜åœ¨ã—ãªãã¦ã‚‚ã€ãƒ‰ã‚ュメントã®ãƒªãƒ³ã‚¯å…ˆã®ãƒ‘ッケージåãŒã‚ã‹ã£ã¦ã„ã‚‹å ´åˆã¯ã€ã“ã®ãƒ•ã‚¡ã‚¤ãƒ«ã®ã‚³ãƒ”ーを手動ã§ä½œæˆã—ã€\f2packagelistLoc\fPã§ãã®ãƒ‘スを指定ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚\f2com.apipackage\fPãŒæœ€åˆã«ç”Ÿæˆã•ã‚ŒãŸæ™‚点ã§\f2com.spipackage\fPã®ãƒ‘ッケージ・リストãŒå˜åœ¨ã—ãªã„ã¨ã„ã†å‰å‡ºã®ã‚±ãƒ¼ã‚¹ãŒä¸€ä¾‹ã¨ã—ã¦æŒ™ã’られã¾ã™ã€‚ã“ã®æ–¹æ³•ã¯ã€ãƒ‘ッケージåã¯ã‚ã‹ã£ã¦ã„ã‚‹ã‚‚ã®ã®ã€ã¾ã 公開ã•ã‚Œã¦ã„ãªã„ã€æ–°ã—ã„外部ドã‚ュメントã«ãƒªãƒ³ã‚¯ã™ã‚‹ãƒ‰ã‚ュメントを生æˆã™ã‚‹å¿…è¦ãŒã‚ã‚‹å ´åˆã«ä¾¿åˆ©ã§ã™ã€‚ã¾ãŸã€\f2package\-list\fPファイルãŒç”Ÿæˆã•ã‚Œãªã„Javadoc 1.0ã¾ãŸã¯1.1ã§ç”Ÿæˆã•ã‚ŒãŸãƒ‘ッケージ用ã«\f2package\-list\fPファイルを作æˆã™ã‚‹å ´åˆã«ã‚‚ã€ã“ã®æ–¹æ³•ãŒä½¿ç”¨ã§ãã¾ã™ã€‚åŒæ§˜ã«ã€2ã¤ã®ä¼æ¥ãŒæœªå…¬é–‹ã®\f2package\-list\fPファイルを共有ã§ãã‚‹ãŸã‚ã€ã‚¯ãƒã‚¹ãƒªãƒ³ã‚¯ã‚’è¨å®šã—ãŸãƒ‰ã‚ュメントをåŒæ™‚ã«ãƒªãƒªãƒ¼ã‚¹ã™ã‚‹ã“ã¨ã‚‚å¯èƒ½ã«ãªã‚Šã¾ã™ã€‚ .br .br \f3複数ã®ãƒ‰ã‚ュメントã¸ã®ãƒªãƒ³ã‚¯\fP \- å‚照先ã¨ãªã‚‹ç”Ÿæˆãƒ‰ã‚ュメントã”ã¨ã«\f2\-linkoffline\fPã‚’1ã¤ãšã¤å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™(ã‚ã‹ã‚Šã‚„ã™ãã™ã‚‹ãŸã‚ã«ã€ã‚ªãƒ—ションã”ã¨ã«æ”¹è¡Œã—ã¦ç¤ºã—ã¦ã„ã¾ã™)。 .br .br \f2% \fP\f4javadoc \-linkoffline\fP \f2extdocURL1\fP \f2packagelistLoc1\fP \f2\\\fP .br \f2\ \ \ \ \ \ \ \ \ \ \fP\f4\-linkoffline\fP \f2extdocURL2\fP \f2packagelistLoc2\fP \f2\\\fP .br \f2\ \ \ \ \ \ \ \ \ \ ...\fP .br .br \f3ドã‚ュメントã®æ›´æ–°\fP \- \f2\-linkoffline\fPオプションã®ã‚‚ã†1ã¤ã®ç”¨é€”ã¯ã€ãƒ—ãƒã‚¸ã‚§ã‚¯ãƒˆã«å¤§é‡ã®ãƒ‘ッケージãŒå«ã¾ã‚Œã¦ã„ã¦ã€ã™ã§ã«ãƒ„リー全体ã«å¯¾ã—ã¦Javadocã®å®Ÿè¡ŒãŒå®Œäº†ã—ã¦ã„ã‚‹å ´åˆã«ã€æ¬¡ã®å®Ÿè¡Œã§ã¯ã€å°‘é‡ã®å¤‰æ›´ã‚’手早ãåŠ ãˆãŸå¾Œã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ„リーã®ã”ã一部ã«å¯¾ã—ã¦ã®ã¿Javadocã‚’å†å®Ÿè¡Œã™ã‚‹å ´åˆã«ä¾¿åˆ©ã§ã™ã€‚ã“ã‚Œã¯ã€ãƒ‰ã‚ュメンテーション・コメントã«å¯¾ã—ã¦ã®ã¿å¤‰æ›´ã‚’åŠ ãˆã€å®£è¨€ã¯å¤‰æ›´ã—ãªã„å ´åˆã«ã®ã¿æ£ã—ã処ç†ã•ã‚Œã‚‹ã®ã§ã€ãƒãƒƒã‚ングã®ã‚ˆã†ãªã‚‚ã®ã§ã™ã€‚ソース・コードã«å¯¾ã—ã¦å®£è¨€ã‚’è¿½åŠ ã€å‰Šé™¤ã€ã¾ãŸã¯å¤‰æ›´ã—ãŸå ´åˆã¯ã€ç´¢å¼•ã€ãƒ‘ッケージ・ツリーã€ç¶™æ‰¿ã•ã‚Œã‚‹ãƒ¡ãƒ³ãƒãƒ¼ã®ãƒªã‚¹ãƒˆã€ä½¿ç”¨ãƒšãƒ¼ã‚¸ãªã©ã®å ´æ‰€ã§ã€ãƒªãƒ³ã‚¯ãŒå£Šã‚Œã‚‹ã“ã¨ãŒã‚ã‚Šã¾ã™ã€‚ .br .br ã¾ãšã€ã“ã®æ–°ã—ã„å°è¦æ¨¡ãªå®Ÿè¡Œã§ä½¿ç”¨ã™ã‚‹ã€æ–°ã—ã„生æˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª(\f2update\fP)を作æˆã—ã¾ã™ã€‚å…ƒã®ç”Ÿæˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã®åå‰ãŒ\f2html\fPã ã£ãŸã¨ã—ã¾ã™ã€‚最もå˜ç´”ãªä¾‹ã§ã¯ã€\f2html\fPディレクトリã®è¦ªã«cdã«ã‚ˆã£ã¦ç§»å‹•ã—ã¾ã™ã€‚\f2\-linkoffline\fPã®ç¬¬1引数ã«ã‚«ãƒ¬ãƒ³ãƒˆãƒ»ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã€Œ.ã€ã‚’è¨å®šã—ã€ç¬¬2引数ã«\f2package\-list\fPãŒæ¤œç´¢ã•ã‚Œã‚‹\f2html\fPã¸ã®ç›¸å¯¾ãƒ‘スをè¨å®šã—ã¾ã™ã€‚æ›´æ–°ã™ã‚‹ãƒ‘ッケージã®ãƒ‘ッケージåã®ã¿ã‚’渡ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-d update \-linkoffline . html com.mypackage\fP .fl .fi Javadocツールã®çµ‚了後ã€\f2update/com/package\fP内ã®ç”Ÿæˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ã®ãƒšãƒ¼ã‚¸ã‚’コピーã—(概è¦ã‚„索引ã¯é™¤ã)ã€\f2html/com/package\fP内ã®å…ƒã®ãƒ•ã‚¡ã‚¤ãƒ«ã«ä¸Šæ›¸ãã—ã¾ã™ã€‚ .TP 3 \-linksource\ å„ソース・ファイル(行番å·ä»˜ã)ã®HTMLãƒãƒ¼ã‚¸ãƒ§ãƒ³ã‚’作æˆã—ã€æ¨™æº–HTMLドã‚ュメントã‹ã‚‰ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¸ã®ãƒªãƒ³ã‚¯ã‚’è¿½åŠ ã—ã¾ã™ã€‚リンクã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«å†…ã«å®£è¨€ã•ã‚Œã¦ã„るクラスã€ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã€ã‚³ãƒ³ã‚¹ãƒˆãƒ©ã‚¯ã‚¿ã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã«å¯¾ã—ã¦ä½œæˆã•ã‚Œã¾ã™ã€‚デフォルト・コンストラクタã€ç”Ÿæˆã•ã‚ŒãŸã‚¯ãƒ©ã‚¹ãªã©ã«å¯¾ã—ã¦ã¯ä½œæˆã•ã‚Œã¾ã›ã‚“。 .br .br \f3ã“ã®ã‚ªãƒ—ションã¯ã€\fP\f4\-public\fP\f3ã€\fP\f4\-package\fP\f3ã€\fP\f4\-protected\fP\f3ã€\fP\f4\-private\fP\f3ã®å„オプションã¨ã¯é–¢ä¿‚ãªã\fP\f3ã€éžå…¬é–‹ã®ã‚¯ãƒ©ã‚¹ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã€éžå…¬é–‹ã®ãƒ¡ã‚½ãƒƒãƒ‰ã®æœ¬ä½“ã‚’ã¯ã˜ã‚ã¨ã™ã‚‹çµ„ã¿è¾¼ã¾ã‚ŒãŸã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«å†…ã®\fP\f4ã™ã¹ã¦ã®\fP\f3éžå…¬é–‹å®Ÿè£…ã®è©³ç´°ã‚’公開ã—ã¾ã™ã€‚\fP\f2\-private\fPオプションも併ã›ã¦æŒ‡å®šã—ãªã„ã‹ãŽã‚Šã€éžå…¬é–‹ã®ã‚¯ãƒ©ã‚¹ã‚„インタフェースã®ä¸€éƒ¨ã«ã¯ã€ãƒªãƒ³ã‚¯ã‚’介ã—ã¦ã‚¢ã‚¯ã‚»ã‚¹ã§ããªã„ã“ã¨ãŒã‚ã‚Šã¾ã™ã€‚ .br .br å„リンクã¯ã€ãã®å®£è¨€å†…ã®è˜åˆ¥ååã®ä¸Šã«ä½œæˆã•ã‚Œã¾ã™ã€‚ãŸã¨ãˆã°ã€\f2Button\fPクラスã®ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã¸ã®ãƒªãƒ³ã‚¯ã¯ã€ã€ŒButtonã€ã¨ã„ã†èªžã®ä¸Šã«ä½œæˆã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl public class Button .fl extends Component .fl implements Accessible .fl \fP .fi ã¾ãŸã€Buttonクラスã®\f2getLabel()\fPメソッドã®ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã¸ã®ãƒªãƒ³ã‚¯ã¯ã€ã€ŒgetLabelã€ã¨ã„ã†èªžã®ä¸Šã«ä½œæˆã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl public String getLabel() .fl \fP .fi .TP 3 \-group\ groupheading\ packagepattern:packagepattern:... 概è¦ãƒšãƒ¼ã‚¸ã®è¤‡æ•°ã®ãƒ‘ッケージをã€æŒ‡å®šã—ãŸã‚°ãƒ«ãƒ¼ãƒ—ã«åˆ†ã‘ã¦ã€ã‚°ãƒ«ãƒ¼ãƒ—ã”ã¨ã«è¡¨ã‚’作æˆã—ã¾ã™ã€‚å„グループã¯ã€ãã‚Œãžã‚Œåˆ¥ã®\f2\-group\fPオプションã§æŒ‡å®šã—ã¾ã™ã€‚ã“れらã®ã‚°ãƒ«ãƒ¼ãƒ—ã¯ã€ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã§æŒ‡å®šã—ãŸé †åºã§ãƒšãƒ¼ã‚¸ã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚å„グループ内ã§ã¯ã€ãƒ‘ッケージãŒã‚¢ãƒ«ãƒ•ã‚¡ãƒ™ãƒƒãƒˆé †ã«ä¸¦ã¹ã‚‰ã‚Œã¾ã™ã€‚1ã¤ã®\f2\-group\fPオプションã§ã¯ã€\f2packagepattern\fPå¼ã®ãƒªã‚¹ãƒˆã«ä¸€è‡´ã™ã‚‹ãƒ‘ッケージãŒã€è¦‹å‡ºã—ã¨ã—ã¦\f2groupheading\fPã‚’æŒã¤1ã¤ã®è¡¨ã«è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .RS 3 .TP 2 o \f4groupheading\fPã«ã¯ã€ä»»æ„ã®ãƒ†ã‚ストを指定ã§ãã€ç©ºç™½ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚指定ã—ãŸãƒ†ã‚ストã¯ã€ã‚°ãƒ«ãƒ¼ãƒ—ã®è¡¨è¦‹å‡ºã—ã«ãªã‚Šã¾ã™ã€‚ .TP 2 o \f4packagepattern\fPã«ã¯ã€ä»»æ„ã®ãƒ‘ッケージåã€ã¾ãŸã¯ä»»æ„ã®ãƒ‘ッケージåã®å…ˆé 部分ã¨ãã‚Œã«ç¶šã1ã¤ã®ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯(\f2*\fP)を指定ã§ãã¾ã™ã€‚アスタリスクã¯ã€ã€Œä»»æ„ã®æ–‡å—ã«ä¸€è‡´ã™ã‚‹ã€ã¨ã„ã†æ„味ã®ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰ã§ã™ã€‚ワイルドカードã¨ã—ã¦æŒ‡å®šã§ãã‚‹ã®ã¯ã€ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã®ã¿ã§ã™ã€‚1ã¤ã®ã‚°ãƒ«ãƒ¼ãƒ—ã«ã¯ã€ã‚³ãƒãƒ³(\f2:\fP)ã§åŒºåˆ‡ã£ã¦è¤‡æ•°ã®ãƒ‘ターンをå«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ .RE \f3注æ„: パターンやパターン・リスト内ã§ã‚¢ã‚¹ã‚¿ãƒªã‚¹ã‚¯ã‚’使用ã™ã‚‹å ´åˆã¯ã€\fP\f4"java.lang*:java.util"\fP\f3ã®ã‚ˆã†ã«ã€ãƒ‘ターン・リストを引用符ã§å›²ã‚€å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\fP .br .br \f2\-group\fPオプションãŒæŒ‡å®šã•ã‚Œã¦ã„ãªã„å ´åˆã€ã™ã¹ã¦ã®ãƒ‘ッケージãŒã€ã€Œãƒ‘ッケージã€ã¨ã„ã†è¦‹å‡ºã—ã®1ã¤ã®ã‚°ãƒ«ãƒ¼ãƒ—ã«å…¥ã‚Œã‚‰ã‚Œã¾ã™ã€‚ドã‚ュメント化ã•ã‚Œã‚‹ãƒ‘ッケージã®ä¸ã«ã€ã©ã®ã‚°ãƒ«ãƒ¼ãƒ—ã«ã‚‚入らãªã„パッケージãŒã‚ã‚‹å ´åˆã€ã“ã®ã‚ˆã†ãªãƒ‘ッケージã¯ã€Œãã®ä»–ã®ãƒ‘ッケージã€ã¨ã„ã†è¦‹å‡ºã—ã‚’æŒã¤ç‹¬ç«‹ã—ãŸã‚°ãƒ«ãƒ¼ãƒ—ã«å…¥ã‚Œã‚‰ã‚Œã¾ã™ã€‚ .br .br ãŸã¨ãˆã°ã€æ¬¡ã®ã‚ˆã†ã«ã‚ªãƒ—ションを指定ã™ã‚‹ã¨ã€ãƒ‰ã‚ュメント化ã•ã‚Œã‚‹5ã¤ã®ãƒ‘ッケージã¯ã€ã‚³ã‚¢ãƒ»ãƒ‘ッケージã€æ‹¡å¼µæ©Ÿèƒ½ãƒ‘ッケージã€ãŠã‚ˆã³ãã®ä»–ã®ãƒ‘ッケージã«åˆ†ã‘られã¾ã™ã€‚「java.lang*ã€ã§ã¯ã€æœ€å¾Œã®ãƒ‰ãƒƒãƒˆã‚’指定ã—ã¦ã„ãªã„ã“ã¨ã«æ³¨ç›®ã—ã¦ãã ã•ã„。「java.lang.*ã€ã®ã‚ˆã†ã«ãƒ‰ãƒƒãƒˆã‚’入れるã¨ã€java.langパッケージã¯é™¤å¤–ã•ã‚Œã‚‹ã“ã¨ã«ãªã‚Šã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-group "Core Packages" "java.lang*:java.util" .fl \-group "Extension Packages" "javax.*" .fl java.lang java.lang.reflect java.util javax.servlet java.new\fP .fl .fi ã“ã®çµæžœã€æ¬¡ã®ã‚ˆã†ãªã‚°ãƒ«ãƒ¼ãƒ—化ãŒè¡Œã‚ã‚Œã¾ã™ã€‚ .RS 3 .TP 3 コア・パッケージ \f2java.lang\fP \f2java.lang.reflect\fP \f2java.util\fP .TP 3 拡張機能パッケージ \f2javax.servlet\fP .TP 3 ãã®ä»–ã®ãƒ‘ッケージ \f2java.new\fP .RE .TP 3 \-nodeprecated 推奨ã•ã‚Œãªã„APIをドã‚ュメントã«ç”Ÿæˆã—ãªã„よã†ã«ã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションを指定ã™ã‚‹ã¨ã€\-nodeprecatedlistオプションを指定ã—ãŸå ´åˆã¨åŒã˜åŠ¹æžœãŒã‚ã‚‹ã“ã¨ã«åŠ ãˆã¦ã€ãƒ‰ã‚ュメントã®ä»–ã®éƒ¨åˆ†å…¨ä½“ã§ã‚‚ã€æŽ¨å¥¨ã•ã‚Œãªã„APIãŒç”Ÿæˆã•ã‚Œã¾ã›ã‚“。ã“ã®ã‚ªãƒ—ションã¯ã€ã‚³ãƒ¼ãƒ‰ã‚’記述ã—ã¦ã„ã‚‹ã¨ãã€æŽ¨å¥¨ã•ã‚Œãªã„コードã«ã‚ˆã£ã¦æ°—を散らã•ã‚ŒãŸããªã„å ´åˆã«ä¾¿åˆ©ã§ã™ã€‚ .TP 3 \-nodeprecatedlist 推奨ã•ã‚Œãªã„APIã®ãƒªã‚¹ãƒˆã‚’å«ã‚€ãƒ•ã‚¡ã‚¤ãƒ«(deprecated\-list.html)ã€ãŠã‚ˆã³ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®ãã®ãƒšãƒ¼ã‚¸ã¸ã®ãƒªãƒ³ã‚¯ãŒç”Ÿæˆã•ã‚Œãªã„よã†ã«ã—ã¾ã™ã€‚(ãŸã ã—ã€ãƒ‰ã‚ュメントã®ä»–ã®éƒ¨åˆ†ã§ã¯ã€æŽ¨å¥¨ã•ã‚Œãªã„APIãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚)ã“ã®ã‚ªãƒ—ションã¯ã€æŽ¨å¥¨ã•ã‚Œãªã„APIãŒã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã«å«ã¾ã‚Œã¦ãŠã‚‰ãšã€ãƒŠãƒ“ゲーション・ãƒãƒ¼ã‚’ã™ã£ãã‚Šã¨è¦‹ã›ã‚‹å ´åˆã«ä¾¿åˆ©ã§ã™ã€‚ .TP 3 \-nosince 生æˆãƒ‰ã‚ュメントã‹ã‚‰ã€@sinceã‚¿ã‚°ã«é–¢é€£ä»˜ã‘られãŸã€Œå°Žå…¥ã•ã‚ŒãŸãƒãƒ¼ã‚¸ãƒ§ãƒ³ã€ã‚»ã‚¯ã‚·ãƒ§ãƒ³ã‚’çœç•¥ã—ã¾ã™ã€‚ .TP 3 \-notree 生æˆãƒ‰ã‚ュメントã‹ã‚‰ã€ã‚¯ãƒ©ã‚¹ãŠã‚ˆã³ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã®éšŽå±¤ãƒšãƒ¼ã‚¸ã‚’çœç•¥ã—ã¾ã™ã€‚ã“れらã®ãƒšãƒ¼ã‚¸ã«ã¯ã€ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®ã€ŒéšŽå±¤ãƒ„リーã€ãƒœã‚¿ãƒ³ã‹ã‚‰ã‚¢ã‚¯ã‚»ã‚¹ã§ãã¾ã™ã€‚デフォルトã§ã¯ã€éšŽå±¤ãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚ .TP 3 \-noindex 生æˆãƒ‰ã‚ュメントã‹ã‚‰ã€ç´¢å¼•ã‚’çœç•¥ã—ã¾ã™ã€‚デフォルトã§ã¯ã€ç´¢å¼•ãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚ .TP 3 \-nohelp 出力ã®å„ページã®æœ€ä¸Šéƒ¨ã¨æœ€ä¸‹éƒ¨ã«ã‚るナビゲーション・ãƒãƒ¼ã‹ã‚‰ã€Œãƒ˜ãƒ«ãƒ—ã€ãƒªãƒ³ã‚¯ã‚’çœç•¥ã—ã¾ã™ã€‚ .TP 3 \-nonavbar 生æˆã•ã‚Œã‚‹ãƒšãƒ¼ã‚¸ã®æœ€ä¸Šéƒ¨ã¨æœ€ä¸‹éƒ¨ã«è¡¨ç¤ºã•ã‚Œã‚‹ãƒŠãƒ“ゲーション・ãƒãƒ¼ã€ãƒ˜ãƒƒãƒ€ãƒ¼ã€ãŠã‚ˆã³ãƒ•ãƒƒã‚¿ãƒ¼ã‚’生æˆã—ãªã„よã†ã«ã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションã¯ã€bottomオプションã«ã¯å½±éŸ¿ã‚’与ãˆã¾ã›ã‚“。\f2\-nonavbar\fPオプションã¯ã€å°åˆ·ã™ã‚‹ãŸã‚ã«ã®ã¿ãƒ•ã‚¡ã‚¤ãƒ«ã‚’PostScriptã‚„PDFã«å¤‰æ›ã™ã‚‹å ´åˆãªã©ã€å†…容ã®ã¿ãŒé‡è¦ã§ã€ãƒŠãƒ“ゲーションã®å¿…è¦ãŒãªã„å ´åˆã«ä¾¿åˆ©ã§ã™ã€‚ .TP 3 \-helpfile\ path/filename 最上部ãŠã‚ˆã³æœ€ä¸‹éƒ¨ã®ãƒŠãƒ“ゲーション・ãƒãƒ¼ã®ã€Œãƒ˜ãƒ«ãƒ—ã€ãƒªãƒ³ã‚¯ã®ãƒªãƒ³ã‚¯å…ˆã¨ãªã‚‹ä»£æ›¿ãƒ˜ãƒ«ãƒ—・ファイル\f2path/filename\fPã®ãƒ‘スを指定ã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションãŒæŒ‡å®šã•ã‚Œã¦ã„ãªã„ã¨ã€Javadocツールã¯ã€ãƒ„ール内ã§ãƒãƒ¼ãƒ‰ã‚³ãƒ¼ãƒ‰ã•ã‚Œã¦ã„るヘルプ・ファイル\f2help\-doc.html\fPを自動作æˆã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションを使用ã™ã‚‹ã¨ã€ãã®ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®å‹•ä½œã‚’オーãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã§ãã¾ã™ã€‚\f2filename\fPã«ã¯ã©ã‚“ãªãƒ•ã‚¡ã‚¤ãƒ«åã§ã‚‚指定ã§ãã€\f2help\-doc.html\fPã«é™å®šã•ã‚Œã¾ã›ã‚“。Javadocツールã¯ã€ãƒŠãƒ“ゲーション・ãƒãƒ¼å†…ã®ãƒªãƒ³ã‚¯ã‚’å¿…è¦ã«å¿œã˜ã¦èª¿æ•´ã—ã¾ã™ã€‚次ã«ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-helpfile /home/user/myhelp.html java.awt\fP .fl .fi .TP 3 \-stylesheetfile\ path/filename 代替HTMLスタイルシート・ファイルã®ãƒ‘スを指定ã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションãŒæŒ‡å®šã•ã‚Œã¦ã„ãªã„ã¨ã€Javadocツールã¯ã€ãƒ„ール内ã§ãƒãƒ¼ãƒ‰ã‚³ãƒ¼ãƒ‰ã•ã‚Œã¦ã„るスタイルシート・ファイル\f2stylesheet.css\fPを自動作æˆã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションを使用ã™ã‚‹ã¨ã€ãã®ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®å‹•ä½œã‚’オーãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã§ãã¾ã™ã€‚\f2filename\fPã«ã¯ã©ã‚“ãªãƒ•ã‚¡ã‚¤ãƒ«åã§ã‚‚指定ã§ãã€\f2stylesheet.css\fPã«é™å®šã•ã‚Œã¾ã›ã‚“。次ã«ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-stylesheetfile /home/user/mystylesheet.css com.mypackage\fP .fl .fi .TP 3 \-serialwarn @serialã‚¿ã‚°ãŒãªã„å ´åˆã¯ã€ã‚³ãƒ³ãƒ‘イル時ã«è¦å‘Šã‚’生æˆã—ã¾ã™ã€‚デフォルトã§ã¯ã€Javadoc 1.2.2 (以é™)ã§ã¯ã€ç›´åˆ—化ã®è¦å‘Šã¯ç”Ÿæˆã•ã‚Œã¾ã›ã‚“。(以å‰ã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ã¨ã¯é€†ã®å‹•ä½œã§ã™ã€‚)ã“ã®ã‚ªãƒ—ションを使用ã™ã‚‹ã¨ã€ç›´åˆ—化ã®è¦å‘ŠãŒè¡¨ç¤ºã•ã‚Œã‚‹ã®ã§ã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®ç›´åˆ—化å¯èƒ½ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã¨\f2writeExternal\fPメソッドをé©åˆ‡ã«ãƒ‰ã‚ュメント化ã™ã‚‹ã®ã«å½¹ç«‹ã¡ã¾ã™ã€‚ .TP 3 \-charset\ name ã“ã®ãƒ‰ã‚ュメント用ã®HTMLæ–‡å—セットを指定ã—ã¾ã™ã€‚ã“ã®åå‰ã¯ã€ .na \f2IANAレジストリ\fP @ .fi http://www.iana.org/assignments/character\-setsã§æŒ‡å®šã•ã‚ŒãŸã€æŽ¨å¥¨ã•ã‚Œã‚‹MIMEåã§ã‚ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚次ã«ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-charset "iso\-8859\-1" mypackage\fP .fl .fi 生æˆã•ã‚Œã‚‹ã™ã¹ã¦ã®ãƒšãƒ¼ã‚¸ã®å…ˆé ã«ã€æ¬¡ã®è¡ŒãŒæŒ¿å…¥ã•ã‚Œã¾ã™ã€‚ .nf \f3 .fl <META http\-equiv="Content\-Type" content="text/html; charset=ISO\-8859\-1"> .fl \fP .fi ã“ã®METAã‚¿ã‚°ã«ã¤ã„ã¦ã¯ã€ .na \f2HTMLè¦æ ¼\fP @ .fi http://www.w3.org/TR/REC\-html40/charset.html#h\-5.2.2(4197265ãŠã‚ˆã³4137321)ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .br .br \-encodingãŠã‚ˆã³\-docencodingã‚‚å‚ç…§ã—ã¦ãã ã•ã„。 .TP 3 \-docencoding\ name 生æˆã•ã‚Œã‚‹HTMLファイルã®ã‚¨ãƒ³ã‚³ãƒ¼ãƒ‡ã‚£ãƒ³ã‚°ã‚’指定ã—ã¾ã™ã€‚ã“ã®åå‰ã¯ã€ .na \f2IANAレジストリ\fP @ .fi http://www.iana.org/assignments/character\-setsã§æŒ‡å®šã•ã‚ŒãŸã€æŽ¨å¥¨ã•ã‚Œã‚‹MIMEåã§ã‚ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションをçœç•¥ã—ãªãŒã‚‰\-encodingを使用ã—ãŸå ´åˆã€ç”Ÿæˆã•ã‚Œã‚‹HTMLファイルã®ã‚¨ãƒ³ã‚³ãƒ¼ãƒ‰ã¯ã€\-encodingã«ã‚ˆã£ã¦æ±ºã‚られã¾ã™ã€‚例: .nf \f3 .fl % \fP\f3javadoc \-docencoding "ISO\-8859\-1" mypackage\fP .fl .fi \-encodingãŠã‚ˆã³\-charsetã‚‚å‚ç…§ã—ã¦ãã ã•ã„。 .TP 3 \-keywords HTMLメタ・ã‚ーワード・タグをã€ã‚¯ãƒ©ã‚¹ã”ã¨ã«ç”Ÿæˆã•ã‚Œã‚‹ãƒ•ã‚¡ã‚¤ãƒ«ã«è¿½åŠ ã—ã¾ã™ã€‚ã“れらã®ã‚¿ã‚°ã¯ã€ãƒ¡ã‚¿ã‚¿ã‚°ã‚’検索ã™ã‚‹ã‚µãƒ¼ãƒãƒ»ã‚¨ãƒ³ã‚¸ãƒ³ãŒãƒšãƒ¼ã‚¸ã‚’見ã¤ã‘ã‚‹å ´åˆã«å½¹ç«‹ã¡ã¾ã™ã€‚(インターãƒãƒƒãƒˆå…¨ä½“を検索ã™ã‚‹å¤šãã®ã‚µãƒ¼ãƒãƒ»ã‚¨ãƒ³ã‚¸ãƒ³ã¯ã€ãƒšãƒ¼ã‚¸ãŒãƒ¡ã‚¿ã‚¿ã‚°ã‚’誤用ã—ã¦ã„ã‚‹å¯èƒ½æ€§ãŒã‚ã‚‹ãŸã‚ã€ãƒ¡ã‚¿ã‚¿ã‚°ã‚’調ã¹ã¾ã›ã‚“。一方ã€æ¤œç´¢ã‚’自身ã®Webサイトã«é™å®šã—ã¦ã„ã‚‹ä¼æ¥ãŒæä¾›ã™ã‚‹ã‚µãƒ¼ãƒãƒ»ã‚¨ãƒ³ã‚¸ãƒ³ã¯ã€ãƒ¡ã‚¿ã‚¿ã‚°ã‚’調ã¹ã‚‹ã“ã¨ã«ã‚ˆã£ã¦ãƒ¡ãƒªãƒƒãƒˆã‚’得られã¾ã™ã€‚) .br .br メタタグã«ã¯ã€ã‚¯ãƒ©ã‚¹ã®å®Œå…¨ä¿®é£¾åã¨ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ãŠã‚ˆã³ãƒ¡ã‚½ãƒƒãƒ‰ã®ä¿®é£¾ã•ã‚Œã¦ã„ãªã„åå‰ãŒå«ã¾ã‚Œã¾ã™ã€‚コンストラクタã¯ã€ã‚¯ãƒ©ã‚¹åã¨åŒã˜ã§ã‚ã‚‹ãŸã‚å«ã¾ã‚Œã¾ã›ã‚“。ãŸã¨ãˆã°ã€ã‚¯ãƒ©ã‚¹Stringã¯æ¬¡ã®ã‚ーワードã§é–‹å§‹ã—ã¾ã™ã€‚ .nf \f3 .fl <META NAME="keywords" CONTENT="java.lang.String class"> .fl <META NAME="keywords" CONTENT="CASE_INSENSITIVE_ORDER"> .fl <META NAME="keywords" CONTENT="length()"> .fl <META NAME="keywords" CONTENT="charAt()"> .fl \fP .fi .TP 3 \-tag\ \ tagname:Xaoptcmf:"taghead" JavadocツールãŒãƒ‰ã‚ュメンテーション・コメント内ã®å¼•æ•°ã‚’1ã¤å–ã‚‹å˜ç´”ãªã‚«ã‚¹ã‚¿ãƒ ブãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°\f2@\fP\f2tagname\fPを解釈ã§ãるよã†ã«ã—ã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€Javadocツールã¯ã‚¿ã‚°åã®ã€Œã‚¹ãƒšãƒ«ãƒã‚§ãƒƒã‚¯ã€ã‚’è¡Œã†ã“ã¨ãŒã§ãã‚‹ã®ã§ã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰å†…ã«å˜åœ¨ã™ã‚‹ã™ã¹ã¦ã®ã‚«ã‚¹ã‚¿ãƒ ・タグã«ã¤ã„ã¦ã€\f2\-tag\fPオプションを組ã¿è¾¼ã‚€ã“ã¨ãŒé‡è¦ã§ã™ã€‚今回ã®å®Ÿè¡Œã§ã¯å‡ºåŠ›ã•ã‚Œãªã„ã‚¿ã‚°ã¯ã€\f2X\fPを付ã‘ã¦ç„¡åŠ¹ã«ã—ã¾ã™ã€‚ .br .br コãƒãƒ³(\f4:\fP)ãŒå¸¸ã«åŒºåˆ‡ã‚Šæ–‡å—ã«ãªã‚Šã¾ã™ã€‚\f2tagname\fPã§ã‚³ãƒãƒ³ã‚’使用ã™ã‚‹æ–¹æ³•ã«ã¤ã„ã¦ã¯ã€ã‚¿ã‚°åã§ã®ã‚³ãƒãƒ³ã®ä½¿ç”¨ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .br .br \f2\-tag\fPオプションã¯ã€ã‚¿ã‚°ã®è¦‹å‡ºã—\f2taghead\fPを太å—ã§å‡ºåŠ›ã—ã¾ã™ã€‚ãã®æ¬¡ã®è¡Œã«ã¯ã€ã“ã®ã‚ªãƒ—ションã®å¼•æ•°ã§æŒ‡å®šã—ãŸãƒ†ã‚ストãŒç¶šãã¾ã™(下ã®ä¾‹ã‚’å‚ç…§)。ブãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ã¨åŒæ§˜ã€ã“ã®å¼•æ•°ã®ãƒ†ã‚ストã«ã¯ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ã‚¿ã‚°ã‚’å«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ã“ã®ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ã‚¿ã‚°ã‚‚解釈ã•ã‚Œã¾ã™ã€‚出力ã¯ã€å¼•æ•°ã‚’1ã¤å–る標準ã®ã‚¿ã‚°(\f2@return\fPã‚„\f2@author\fPãªã©)ã®å‡ºåŠ›ã¨ã‚ˆãä¼¼ã¦ã„ã¾ã™ã€‚\f2taghead\fPã‚’çœç•¥ã™ã‚‹ã¨ã€\f2tagname\fPãŒè¦‹å‡ºã—ã¨ã—ã¦è¡¨ç¤ºã•ã‚Œã¾ã™ã€‚ .br .br \f3ã‚¿ã‚°ã®é…ç½®\fP \- 引数ã®\f4Xaoptcmf\fP部分ã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰å†…ã®ã‚¿ã‚°ã‚’é…ç½®ã§ãã‚‹ä½ç½®ã¨ã€ã‚¿ã‚°ã‚’(\f2X\fPを使用ã—ã¦)無効ã«ã§ãã‚‹ã‹ã©ã†ã‹ã‚’決定ã—ã¾ã™ã€‚ã‚¿ã‚°ã®é…ç½®ä½ç½®ã‚’制é™ã—ãªã„å ´åˆã¯\f4a\fPを指定ã—ã¾ã™ã€‚ãれ以外ã®æ–‡å—ã®çµ„åˆã›ã‚‚å¯èƒ½ã§ã™ã€‚ .br .br \f4X\fP (ã‚¿ã‚°ã®ç„¡åŠ¹åŒ–) .br \f4a\fP (ã™ã¹ã¦) .br \f4o\fP (概è¦) .br \f4p\fP (パッケージ) .br \f4t\fP (åž‹ã€ã¤ã¾ã‚Šã‚¯ãƒ©ã‚¹ã¨ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹) .br \f4c\fP (コンストラクタ) .br \f4m\fP (メソッド) .br \f4f\fP (フィールド) .br .br \f3シングル・タグã®ä¾‹\fP \- ソース・コード内ã®ä»»æ„ã®ä½ç½®ã§ä½¿ç”¨ã§ãã‚‹ã‚¿ã‚°ã®ã‚¿ã‚°ãƒ»ã‚ªãƒ—ションã®ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl \-tag todo:a:"To Do:" .fl \fP .fi @todoをコンストラクタã€ãƒ¡ã‚½ãƒƒãƒ‰ã€ãƒ•ã‚£ãƒ¼ãƒ«ãƒ‰ã®ã¿ã§ä½¿ç”¨ã™ã‚‹å ´åˆã¯ã€æ¬¡ã®ã‚ªãƒ—ションを使用ã—ã¾ã™ã€‚ .nf \f3 .fl \-tag todo:cmf:"To Do:" .fl \fP .fi 上ã®ä¾‹ã®æœ€å¾Œã®ã‚³ãƒãƒ³(\f2:\fP)ã¯ã€ãƒ‘ラメータ区切り文å—ã§ã¯ãªãã€è¦‹å‡ºã—テã‚ストã®ä¸€éƒ¨ã«ãªã£ã¦ã„ã¾ã™(下ã®ä¾‹ã‚’å‚ç…§)。次ã®ä¾‹ã®ã‚ˆã†ã«ã€\f2@todo\fPã‚¿ã‚°ã‚’å«ã‚€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰ã§ã¯ã€ã„ãšã‚Œã‹ã®ã‚¿ã‚°ãƒ»ã‚ªãƒ—ションを使用ã—ã¾ã™ã€‚ .nf \f3 .fl @todo The documentation for this method needs work. .fl \fP .fi \f3ã‚¿ã‚°åã§ã®ã‚³ãƒãƒ³ã®ä½¿ç”¨\fP \- コãƒãƒ³(:)ã‚’ãƒãƒƒã‚¯ã‚¹ãƒ©ãƒƒã‚·ãƒ¥ã§ã‚¨ã‚¹ã‚±ãƒ¼ãƒ—ã™ã‚‹ã¨ã€ã‚³ãƒãƒ³ã‚’ã‚¿ã‚°åã«ä½¿ç”¨ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ã“ã®ãƒ‰ã‚ュメンテーション・コメントã®ä¸ã§ã¯ã€æ¬¡ã®ã‚ˆã†ã«ä½¿ç”¨ã—ã¾ã™ã€‚ .nf \f3 .fl /** .fl * @ejb:bean .fl */ .fl \fP .fi ã“ã®ã‚¿ã‚°ãƒ»ã‚ªãƒ—ションを使用ã™ã‚‹ã¨ã€æ¬¡ã®ã‚ˆã†ã«ãªã‚Šã¾ã™ã€‚ .nf \f3 .fl \-tag ejb\\\\:bean:a:"EJB Bean:" .fl \fP .fi \f3ã‚¿ã‚°åã®ã‚¹ãƒšãƒ«ãƒã‚§ãƒƒã‚¯(ã‚¿ã‚°ã®ç„¡åŠ¹åŒ–)\fP \- 一部ã®é–‹ç™ºè€…ãŒå¿…ãšã—も出力ã—ãªã„カスタム・タグをソース・コード内ã«é…ç½®ã™ã‚‹ã“ã¨ãŒã‚ã‚Šã¾ã™ã€‚ã“ã®å ´åˆã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰å†…ã«å˜åœ¨ã™ã‚‹ã™ã¹ã¦ã®ã‚¿ã‚°ã‚’リストã—ã€å‡ºåŠ›ã™ã‚‹ã‚¿ã‚°ã‚’有効ã«ã—ã€å‡ºåŠ›ã—ãªã„タグを無効ã«ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚\f2X\fPを指定ã™ã‚‹ã¨ã‚¿ã‚°ã¯ç„¡åŠ¹ã«ãªã‚Šã¾ã™ã€‚指定ã—ãªã„ã¨ã€ã‚¿ã‚°ã¯æœ‰åŠ¹ã«ãªã‚Šã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€Javadocツールã¯ã€æ¤œå‡ºã—ãŸã‚¿ã‚°ãŒå…¥åŠ›ãƒŸã‚¹ãªã©ã«ã‚ˆã‚‹ä¸æ˜Žã‚¿ã‚°ã§ã‚ã‚‹ã‹ã©ã†ã‹ã‚’特定ã§ãã¾ã™ã€‚ã“ã®å ´åˆã¯è¦å‘ŠãŒå‡ºåŠ›ã•ã‚Œã¾ã™ã€‚ .br .br ã™ã§ã«é…ç½®ã•ã‚Œã¦ã„る値ã«\f2X\fPã‚’è¿½åŠ ã§ãã¾ã™ã€‚ã“ã†ã—ã¦ãŠã‘ã°ã€\f2X\fPを削除ã™ã‚‹ã®ã¿ã§ã‚¿ã‚°ã‚’有効ã«ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ãŸã¨ãˆã°ã€@todoã‚¿ã‚°ã®å‡ºåŠ›ã‚’抑制ã™ã‚‹å ´åˆã€æ¬¡ã®ã‚ˆã†ã«æŒ‡å®šã—ã¾ã™ã€‚ .nf \f3 .fl \-tag todo:Xcmf:"To Do:" .fl \fP .fi ã•ã‚‰ã«å˜ç´”ãªæŒ‡å®šæ–¹æ³•ã‚‚ã‚ã‚Šã¾ã™ã€‚ .nf \f3 .fl \-tag todo:X .fl \fP .fi 構文\f2\-tag todo:X\fPã¯ã€\f2@todo\fPãŒã‚¿ã‚°ãƒ¬ãƒƒãƒˆã§å®šç¾©ã•ã‚Œã¦ã„ã¦ã‚‚機能ã—ã¾ã™ã€‚ .br .br \f3ã‚¿ã‚°ã®é †åº\fP \- \f2\-tag\fP (ãŠã‚ˆã³\f2\-taglet\fP)オプションã®é †åºã«ã‚ˆã£ã¦ã€ã‚¿ã‚°ã®å‡ºåŠ›é †ãŒæ±ºã¾ã‚Šã¾ã™ã€‚カスタム・タグã¨æ¨™æº–タグを組ã¿åˆã›ã¦ä½¿ç”¨ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚標準タグã®ã‚¿ã‚°ãƒ»ã‚ªãƒ—ションã¯ã€é †åºã‚’決定ã™ã‚‹ãŸã‚ã®ã¿ã®ãƒ—レースホルダã§ã™ã€‚ã“れらã¯æ¨™æº–ã‚¿ã‚°åã®ã¿ã‚’使用ã—ã¾ã™ã€‚(標準タグã®å°è¦‹å‡ºã—ã¯å¤‰æ›´ã§ãã¾ã›ã‚“。)ã“ã‚Œã«ã¤ã„ã¦ã¯ã€ä¸‹ã®ä¾‹ã§èª¬æ˜Žã—ã¾ã™ã€‚ .br .br \f2\-tag\fPãŒãªã„å ´åˆã¯ã€\f2\-taglet\fPã®ä½ç½®ã«ã‚ˆã£ã¦ãã®é †åºãŒæ±ºã¾ã‚Šã¾ã™ã€‚ã‚¿ã‚°ãŒä¸¡æ–¹ã¨ã‚‚å˜åœ¨ã™ã‚‹å ´åˆã€ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã®æœ€å¾Œã«ã‚ã‚‹æ–¹ãŒãã®é †åºã‚’決定ã—ã¾ã™ã€‚ã“ã‚Œã¯ã€ã‚¿ã‚°ã‚„タグレットãŒã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã«æŒ‡å®šã•ã‚ŒãŸé †ç•ªã«å‡¦ç†ã•ã‚Œã‚‹ãŸã‚ã§ã™ã€‚ãŸã¨ãˆã°ã€\f2\-taglet\fPã¨\f2\-tag\fPã®ä¸¡æ–¹ãŒã€Œtodoã€ã¨ã„ã†åå‰ã‚’æŒã£ã¦ã„ã‚‹å ´åˆã€ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã®æœ€å¾Œã«ã‚ã‚‹æ–¹ãŒé †åºã‚’決定ã—ã¾ã™ã€‚ .br .br \f3ã‚¿ã‚°ã®å®Œå…¨ã‚»ãƒƒãƒˆã®ä¾‹\fP \- ã“ã®ä¾‹ã§ã¯ã€å‡ºåŠ›ã®ã€ŒParametersã€ã¨ã€ŒThrowsã€ã®é–“ã«ã€ŒTo Doã€ã‚’挿入ã—ã¾ã™ã€‚「Xã€ã‚’使用ã—ã¦ã€@exampleãŒã€ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰å†…ã®ä»Šå›žã®å®Ÿè¡Œã§ã¯å‡ºåŠ›ã•ã‚Œãªã„ã‚¿ã‚°ã§ã‚ã‚‹ã“ã¨ã‚’指定ã—ã¾ã™ã€‚@argfileを使用ã™ã‚‹å ´åˆã¯ã€æ¬¡ã®ã‚ˆã†ã«ã€å¼•æ•°ãƒ•ã‚¡ã‚¤ãƒ«å†…ã®åˆ¥ã€…ã®è¡Œã«ã‚¿ã‚°ã‚’é…ç½®ã§ãã¾ã™(è¡Œã®ç¶™ç¶šã‚’示ã™æ–‡å—ã¯ä¸è¦)。 .nf \f3 .fl \-tag param .fl \-tag return .fl \-tag todo:a:"To Do:" .fl \-tag throws .fl \-tag see .fl \-tag example:X .fl \fP .fi JavadocãŒãƒ‰ã‚ュメンテーション・コメントを解æžã™ã‚‹éš›ã«æ¤œç´¢ã•ã‚ŒãŸã‚¿ã‚°ã®ã†ã¡ã€æ¨™æº–ã‚¿ã‚°ã§ã‚‚ã€\f2\-tag\fPã‚„\f2\-taglet\fPã§æ¸¡ã•ã‚ŒãŸã‚¿ã‚°ã§ã‚‚ãªã„ã‚‚ã®ã¯ã™ã¹ã¦ä¸æ˜Žã‚¿ã‚°ã¨ã¿ãªã•ã‚Œã€è¦å‘ŠãŒã‚¹ãƒãƒ¼ã•ã‚Œã¾ã™ã€‚ .br .br 標準タグã¯ã€æœ€åˆã€ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®é †åºã§ãƒªã‚¹ãƒˆå†…ã«å†…部的ã«æ ¼ç´ã•ã‚Œã¾ã™ã€‚\f2\-tag\fPオプションを使用ã™ã‚‹ã¨ã€ã“ã®ãƒªã‚¹ãƒˆã«è¿½åŠ ã•ã‚Œã‚‹ã‚¿ã‚°ã€ã™ãªã‚ã¡æ¨™æº–ã‚¿ã‚°ãŒãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®ä½ç½®ã‹ã‚‰ç§»å‹•ã—ã¾ã™ã€‚ã¤ã¾ã‚Šã€æ¨™æº–ã‚¿ã‚°ã®\f2\-tag\fPオプションをçœç•¥ã™ã‚‹ã¨ã€ã“れらã¯ãƒ‡ãƒ•ã‚©ãƒ«ãƒˆã®ä½ç½®ã«é…ç½®ã•ã‚ŒãŸã¾ã¾ã«ãªã‚Šã¾ã™ã€‚ .br .br \f3競åˆã®å›žé¿\fP \- 固有ã®åå‰ç©ºé–“ã‚’ç´°ã‹ã分ã‘ã‚‹ã«ã¯ã€ãƒ‘ッケージã«ä½¿ç”¨ã•ã‚Œã¦ã„ã‚‹\f2com.mycompany.todo\fPã¨ã„ã†åå‰ã®ã‚ˆã†ã«ã€ãƒ‰ãƒƒãƒˆ(.)ã§åŒºåˆ‡ã‚‰ã‚ŒãŸåå‰ã‚’使用ã—ã¾ã™ã€‚Oracleã¯ã€ä»Šå¾Œã‚‚åå‰ã«ãƒ‰ãƒƒãƒˆã‚’å«ã¾ãªã„標準タグを作æˆã—ã¾ã™ã€‚ユーザーãŒä½œæˆã—ãŸã‚¿ã‚°ã¯ã€OracleãŒå®šç¾©ã™ã‚‹åŒã˜åå‰ã®ã‚¿ã‚°ã®å‹•ä½œã‚’オーãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã—ã¾ã™ã€‚ã¤ã¾ã‚Šã€\f2@todo\fPã¨ã„ã†åå‰ã®ã‚¿ã‚°ã¾ãŸã¯ã‚¿ã‚°ãƒ¬ãƒƒãƒˆã‚’ユーザーãŒä½œæˆã—ãŸå ´åˆã€ãã®å¾Œã«OracleãŒåŒã˜åå‰ã®æ¨™æº–タグを作æˆã—ã¦ã‚‚ã€ãã®ã‚¿ã‚°ã¾ãŸã¯ã‚¿ã‚°ãƒ¬ãƒƒãƒˆã¯å¸¸ã«ãƒ¦ãƒ¼ã‚¶ãƒ¼ãŒå®šç¾©ã—ãŸã®ã¨åŒã˜å‹•ä½œã‚’ä¿æŒã—ã¾ã™ã€‚ .br .br \f3注釈vs. Javadocã‚¿ã‚°\fP \- 一般ã«ã€è¿½åŠ ã™ã‚‹å¿…è¦ã®ã‚るマークアップãŒã€ãƒ‰ã‚ュメントã«å½±éŸ¿ã‚’与ãˆãŸã‚Šãƒ‰ã‚ュメントを生æˆã—ãŸã‚Šã™ã‚‹ãŸã‚ã®ã‚‚ã®ã§ã‚ã‚‹å ´åˆã€ãã®ãƒžãƒ¼ã‚¯ã‚¢ãƒƒãƒ—ã¯Javadocã‚¿ã‚°ã«ã—ã¾ã™ã€‚ãれ以外ã®å ´åˆã¯æ³¨é‡ˆã«ã—ã¾ã™ã€‚ .na \f2注釈ã¨Javadocã‚¿ã‚°ã®æ¯”較\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html#annotationsã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .br .br \-tagletオプションを使用ã—ã¦ã€ã‚ˆã‚Šè¤‡é›‘ãªãƒ–ãƒãƒƒã‚¯ãƒ»ã‚¿ã‚°ã‚„カスタム・インライン・タグを作æˆã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚ .TP 3 \-taglet\ \ class ãã®ã‚¿ã‚°ã®ãƒ‰ã‚ュメントã®ç”Ÿæˆã«ä½¿ç”¨ã™ã‚‹ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã‚’èµ·å‹•ã™ã‚‹ãŸã‚ã®ã‚¯ãƒ©ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’指定ã—ã¾ã™ã€‚\f2クラス\fPã®å®Œå…¨ä¿®é£¾åを指定ã—ã¦ãã ã•ã„。ã“ã®ã‚¿ã‚°ãƒ¬ãƒƒãƒˆã¯ã€ã‚«ã‚¹ã‚¿ãƒ ・タグã®ãƒ†ã‚スト引数ã®æ•°ã‚‚定義ã—ã¾ã™ã€‚タグレットã¯ã€ã“れらã®å¼•æ•°ã‚’å—ã‘付ã‘ã€å‡¦ç†ã—ã€å‡ºåŠ›ã‚’生æˆã—ã¾ã™ã€‚外部ドã‚ュメントã¨ã‚µãƒ³ãƒ—ル・タグレットã«ã¤ã„ã¦ã¯ã€æ¬¡ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .RS 3 .TP 2 o .na \f2タグレットã®æ¦‚è¦\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/taglet/overview.html .RE タグレットã¯ã€ãƒ–ãƒãƒƒã‚¯ã‚¿ã‚°ã¾ãŸã¯ã‚¤ãƒ³ãƒ©ã‚¤ãƒ³ãƒ»ã‚¿ã‚°ã§ä¾¿åˆ©ã§ã™ã€‚タグレットã¯ä»»æ„ã®æ•°ã®å¼•æ•°ã‚’ã¨ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ã¾ãŸã€ãƒ†ã‚ストを太å—ã«ã™ã‚‹ã€ç®‡æ¡æ›¸ãを作æˆã™ã‚‹ã€ãƒ†ã‚ストをファイルã«æ›¸ã出ã™ã€ãã®ä»–ã®ãƒ—ãƒã‚»ã‚¹ã‚’開始ã™ã‚‹ãªã©ã®ã‚«ã‚¹ã‚¿ãƒ 動作を実装ã§ãã¾ã™ã€‚ .br .br タグレットã§æŒ‡å®šã§ãã‚‹ã®ã¯ã€ã‚¿ã‚°ã®é…ç½®å ´æ‰€ã¨é…置形å¼ã®ã¿ã§ã™ã€‚ãã®ä»–ã®ã™ã¹ã¦ã®æ±ºå®šã¯ã€ãƒ‰ãƒƒã‚¯ãƒ¬ãƒƒãƒˆã«ã‚ˆã£ã¦è¡Œã‚ã‚Œã¾ã™ã€‚ã—ãŸãŒã£ã¦ã€ã‚¿ã‚°ãƒ¬ãƒƒãƒˆã‚’使用ã—ã¦ã‚‚ã€åŒ…å«ã‚¯ãƒ©ã‚¹ã®ãƒªã‚¹ãƒˆã‹ã‚‰ã‚¯ãƒ©ã‚¹åを削除ã™ã‚‹ãªã©ã®å‡¦ç†ã¯å®Ÿè¡Œã§ãã¾ã›ã‚“。ãŸã ã—ã€ã‚¿ã‚°ã®ãƒ†ã‚ストをファイルã«å‡ºåŠ›ã—ãŸã‚Šã€åˆ¥ã®ãƒ—ãƒã‚»ã‚¹ã‚’トリガーã™ã‚‹ãªã©ã®å‰¯ä½œç”¨ã¯å¾—られã¾ã™ã€‚ .br .br タグレットã¸ã®ãƒ‘スを指定ã™ã‚‹ã«ã¯ã€\f2\-tagletpath\fPオプションを使用ã—ã¾ã™ã€‚次ã«ã€ç”Ÿæˆã•ã‚Œã‚‹ãƒšãƒ¼ã‚¸ã®ã€ŒParametersã€ã¨ã€ŒThrowsã€ã®é–“ã«ã€ŒTo Doã€ã‚¿ã‚°ãƒ¬ãƒƒãƒˆã‚’挿入ã™ã‚‹ä¾‹ã‚’示ã—ã¾ã™ã€‚ .nf \f3 .fl \-taglet com.sun.tools.doclets.ToDoTaglet .fl \-tagletpath /home/taglets .fl \-tag return .fl \-tag param .fl \-tag todo .fl \-tag throws .fl \-tag see .fl \fP .fi ã¾ãŸã€\f2\-taglet\fPオプションを\f2\-tag\fPオプションã®ã‹ã‚ã‚Šã«ä½¿ç”¨ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ãŒã€èªã¿ã«ãããªã‚‹å¯èƒ½æ€§ãŒã‚ã‚Šã¾ã™ã€‚ .TP 3 \-tagletpath\ \ tagletpathlist tagletクラス・ファイル(.class)を検索ã™ã‚‹ãŸã‚ã®æ¤œç´¢ãƒ‘スを指定ã—ã¾ã™ã€‚\f2tagletpathlist\fPã«ã¯ã€ã‚³ãƒãƒ³(\f2:\fP)ã§åŒºåˆ‡ã£ã¦è¤‡æ•°ã®ãƒ‘スをå«ã‚ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚Javadocツールã¯ã€æŒ‡å®šã•ã‚ŒãŸãƒ‘ス以下ã®ã™ã¹ã¦ã®ã‚µãƒ–ディレクトリを検索ã—ã¾ã™ã€‚ .TP 3 \-docfilessubdirs\ 「\f2doc\-files\fPã€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã®ãƒ‡ã‚£ãƒ¼ãƒ—・コピーを有効ã«ã—ã¾ã™ã€‚ã¤ã¾ã‚Šã€å®›å…ˆã«ã¯ã€ã‚µãƒ–ディレクトリã¨ãã®ã™ã¹ã¦å†…容ãŒå†å¸°çš„ã«ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ãŸã¨ãˆã°ã€ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª\f2doc\-files/example/images\fPã¨ãã®å†…容ãŒã™ã¹ã¦ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ã“ã“ã§ã‚‚ã€ã‚µãƒ–ディレクトリを除外ã™ã‚‹æŒ‡å®šãŒå¯èƒ½ã§ã™ã€‚ .TP 3 \-excludedocfilessubdir\ \ name1:name2... 指定ã•ã‚ŒãŸåå‰ã®ã€Œ\f2doc\-files\fPã€ã‚µãƒ–ディレクトリをã™ã¹ã¦é™¤å¤–ã—ã¾ã™ã€‚ã“ã‚Œã«ã‚ˆã‚Šã€SCCSã¨ãã®ä»–ã®ã‚½ãƒ¼ã‚¹ãƒ»ã‚³ãƒ¼ãƒ‰åˆ¶å¾¡ã‚µãƒ–ディレクトリã®ã‚³ãƒ”ーを防ãŽã¾ã™ã€‚ .TP 3 \-noqualifier\ \ all\ | \ packagename1:packagename2:... 出力ã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹åã®å…ˆé ã‹ã‚‰ãƒ‘ッケージå(パッケージ修飾å)ã‚’çœç•¥ã—ã¾ã™ã€‚\f2\-noqualifier\fPã®å¼•æ•°ã¯ã€ã€Œ\f2all\fPã€(ã™ã¹ã¦ã®ãƒ‘ッケージ修飾åã‚’çœç•¥)ã€ä¿®é£¾åã¨ã—ã¦å‰Šé™¤ã™ã‚‹ãƒ‘ッケージã®ã‚³ãƒãƒ³åŒºåˆ‡ã‚Šãƒªã‚¹ãƒˆ(ワイルドカードもå¯)ã€ã®ã„ãšã‚Œã‹ã¨ãªã‚Šã¾ã™ã€‚クラスã¾ãŸã¯ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹åãŒè¡¨ç¤ºã•ã‚Œã‚‹ä½ç½®ã‹ã‚‰ãƒ‘ッケージåãŒå‰Šé™¤ã•ã‚Œã¾ã™ã€‚ .br .br 次ã®ä¾‹ã§ã¯ã€ã™ã¹ã¦ã®ãƒ‘ッケージ修飾åã‚’çœç•¥ã—ã¾ã™ã€‚ .nf \f3 .fl \-noqualifier all .fl \fP .fi 次ã®ä¾‹ã§ã¯ã€ãƒ‘ッケージ修飾å「java.langã€ãŠã‚ˆã³ã€Œjava.ioã€ã‚’çœç•¥ã—ã¾ã™ã€‚ .nf \f3 .fl \-noqualifier java.lang:java.io .fl \fP .fi 次ã®ä¾‹ã§ã¯ã€ã€Œjavaã€ã§å§‹ã¾ã‚‹ãƒ‘ッケージ修飾åã¨ã€Œcom.sunã€ã¨ã„ã†ã‚µãƒ–パッケージ(「javaxã€ã§ã¯ãªã„)ã‚’çœç•¥ã—ã¾ã™ã€‚ .nf \f3 .fl \-noqualifier java.*:com.sun.* .fl \fP .fi パッケージ修飾åãŒå‰è¿°ã®å‹•ä½œã«å¾“ã£ã¦è¡¨ç¤ºã•ã‚Œã‚‹å ´åˆã€åå‰ã¯é©åˆ‡ã«çŸç¸®ã•ã‚Œã¾ã™ã€‚詳細ã¯ã€åå‰ãŒè¡¨ç¤ºã•ã‚Œã‚‹æ–¹æ³•ã‚’å‚ç…§ã—ã¦ãã ã•ã„。ã“ã®ãƒ«ãƒ¼ãƒ«ã¯ã€\f2\-noqualifier\fPを使用ã™ã‚‹ã‹ã©ã†ã‹ã«ã‹ã‹ã‚らãšæœ‰åŠ¹ã§ã™ã€‚ .TP 3 \-notimestamp\ タイムスタンプãŒæŠ‘制ã•ã‚Œã¾ã™ã€‚å„ページã®å…ˆé è¿‘ãã«ã‚ã‚‹ã€ç”Ÿæˆã•ã‚ŒãŸHTML内ã®HTMLコメントã§ã‚¿ã‚¤ãƒ スタンプãŒéš ã•ã‚Œã¾ã™ã€‚Javadocã‚’2ã¤ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ™ãƒ¼ã‚¹ã§å®Ÿè¡Œã—ã€ãれらã«å¯¾ã—ã¦diffを実行ã™ã‚‹ã¨ãã«ã“ã®ã‚ªãƒ—ションを使用ã™ã‚‹ã¨ã€ã‚¿ã‚¤ãƒ スタンプã«ã‚ˆã£ã¦diffãŒç™ºç”Ÿã—ãªããªã‚‹ã®ã§ä¾¿åˆ©ã§ã™(ã“ã®ã‚ªãƒ—ションを使用ã—ãªã„ã¨ã€å„ページã§diffã«ãªã‚Šã¾ã™)。タイムスタンプã«ã¯Javadocã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ãŒå«ã¾ã‚Œã¦ãŠã‚Šã€æ¬¡ã®ã‚ˆã†ã«ãªã‚Šã¾ã™ã€‚ .nf \f3 .fl <!\-\- Generated by javadoc (build 1.5.0_01) on Thu Apr 02 14:04:52 IST 2009 \-\-> .fl \fP .fi .TP 3 \-nocomment\ 主説明ãŠã‚ˆã³ã™ã¹ã¦ã®ã‚¿ã‚°ã‚’å«ã‚€ã‚³ãƒ¡ãƒ³ãƒˆæœ¬æ–‡å…¨ä½“を抑制ã—ã€å®£è¨€ã®ã¿ã‚’生æˆã—ã¾ã™ã€‚ã“ã®ã‚ªãƒ—ションã«ã‚ˆã‚Šã€å…ƒã¯ç•°ãªã‚‹ç›®çš„ã®ãŸã‚ã ã£ãŸã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’å†åˆ©ç”¨ã—ã€æ–°ã—ã„プãƒã‚¸ã‚§ã‚¯ãƒˆã®æ—©ã„段階ã§ã‚¹ã‚±ãƒ«ãƒˆãƒ³HTMLドã‚ュメントを作æˆã§ãるよã†ã«ãªã‚Šã¾ã™ã€‚ .TP 3 \-sourcetab tabLength ソース内ã®å„タブãŒå–る空白文å—ã®æ•°ã‚’指定ã—ã¾ã™ã€‚ .RE .SH "コマンドライン引数ファイル" .LP Javadocã®ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã‚’çŸãã—ãŸã‚Šç°¡æ½”ã«ã—ãŸã‚Šã™ã‚‹ãŸã‚ã«ã€\f2javadoc\fPコマンドã«å¯¾ã™ã‚‹å¼•æ•°(\f2\-J\fPオプションを除ã)ãŒå…¥ã£ãŸ1ã¤ä»¥ä¸Šã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’指定ã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ã“ã®ã“ã¨ã‚’利用ã™ã‚Œã°ã€ã©ã®ã‚ªãƒšãƒ¬ãƒ¼ãƒ†ã‚£ãƒ³ã‚°ãƒ»ã‚·ã‚¹ãƒ†ãƒ 上ã§ã‚‚ã€ä»»æ„ã®é•·ã•ã®javadocコマンドを作æˆã§ãã¾ã™ã€‚ .LP 引数ファイルã«ã¯ã€javacã®ã‚ªãƒ—ションã¨ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«åを自由ã«çµ„ã¿åˆã›ã¦è¨˜è¿°ã§ãã¾ã™ã€‚ファイル内ã®å„引数ã¯ã€ã‚¹ãƒšãƒ¼ã‚¹ã¾ãŸã¯æ”¹è¡Œã§åŒºåˆ‡ã‚Šã¾ã™ã€‚ファイルåã«ç©ºç™½ãŒå«ã¾ã‚Œã¦ã„ã‚‹å ´åˆã¯ã€ãã®ãƒ•ã‚¡ã‚¤ãƒ«å全体を二é‡å¼•ç”¨ç¬¦ã§å›²ã¿ã¾ã™ã€‚ .LP 引数ファイル内ã®ãƒ•ã‚¡ã‚¤ãƒ«åã¯ã€ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰è¦‹ãŸç›¸å¯¾ãƒ‘スã«ãªã‚Šã¾ã™ã€‚引数ファイルã®ä½ç½®ã‹ã‚‰è¦‹ãŸç›¸å¯¾ãƒ‘スã§ã¯ã‚ã‚Šã¾ã›ã‚“。引数ファイル内ã®ãƒ•ã‚¡ã‚¤ãƒ«åリストã§ã¯ã€ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰(*)ã¯ä½¿ç”¨ã§ãã¾ã›ã‚“。ãŸã¨ãˆã°ã€\f2*.java\fPã¨ã¯æŒ‡å®šã§ãã¾ã›ã‚“。引数ファイル内ã®å¼•æ•°ã§\f2@\fPæ–‡å—を使用ã—ã¦ã€è¤‡æ•°ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’å†å¸°çš„ã«è§£é‡ˆã™ã‚‹ã“ã¨ã¯ã‚µãƒãƒ¼ãƒˆã•ã‚Œã¦ã„ã¾ã›ã‚“。ã¾ãŸã€\f2\-J\fPオプションもサãƒãƒ¼ãƒˆã•ã‚Œã¦ã„ã¾ã›ã‚“。ã“ã®ã‚ªãƒ—ションã¯èµ·å‹•ãƒ„ールã«æ¸¡ã•ã‚Œã¾ã™ãŒã€èµ·å‹•ãƒ„ールã§ã¯å¼•æ•°ãƒ•ã‚¡ã‚¤ãƒ«ã‚’サãƒãƒ¼ãƒˆã—ã¦ã„ãªã„ã‹ã‚‰ã§ã™ã€‚ .LP Javadocを実行ã™ã‚‹ã¨ãã«ã€å„引数ファイルã®ãƒ‘スã¨ãƒ•ã‚¡ã‚¤ãƒ«åã®å…ˆé ã«\f2@\fPæ–‡å—を付ã‘ã¦æ¸¡ã—ã¾ã™ã€‚Javadocã¯ã€\f2@\fPæ–‡å—ã§å§‹ã¾ã‚‹å¼•æ•°ã‚’見ã¤ã‘ã‚‹ã¨ã€ãã®ãƒ•ã‚¡ã‚¤ãƒ«ã®å†…容を展開ã—ã¦å¼•æ•°ãƒªã‚¹ãƒˆã«æŒ¿å…¥ã—ã¾ã™ã€‚ .SS 引数ファイルを1ã¤æŒ‡å®šã™ã‚‹ä¾‹ .LP 次ã®ã‚ˆã†ã«ã—ã¦ã€ã€Œ\f2argfile\fPã€ã¨ã„ã†åå‰ã®å˜ä¸€ã®å¼•æ•°ãƒ•ã‚¡ã‚¤ãƒ«ã«ã€ã™ã¹ã¦ã®Javadocå¼•æ•°ã‚’æ ¼ç´ã§ãã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc @argfile\fP .fl .fi .LP ã“ã®å¼•æ•°ãƒ•ã‚¡ã‚¤ãƒ«ã«ã¯ã€æ¬¡ã®ä¾‹ã§ç¤ºã•ã‚Œã¦ã„ã‚‹2ã¤ã®ãƒ•ã‚¡ã‚¤ãƒ«ã®å†…容を両方ã¨ã‚‚入れるã“ã¨ãŒã§ãã¾ã™ã€‚ .SS 引数ファイルを2ã¤æŒ‡å®šã™ã‚‹ä¾‹ .LP 次ã®ã‚ˆã†ã«ã—ã¦ã€Javadocオプション用ã«1ã¤ã€ãƒ‘ッケージåã¾ãŸã¯ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«å用ã«1ã¤ã¨ã„ã†ã‚ˆã†ã«ã€2ã¤ã®å¼•æ•°ãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆã§ãã¾ã™(ãªãŠã€æ¬¡ã®ãƒªã‚¹ãƒˆã§ã¯è¡Œç¶™ç¶šæ–‡å—を使用ã—ã¦ã„ã¾ã›ã‚“)。 .LP 次ã®å†…容をå«ã‚€ã€ã€Œ\f2options\fPã€ã¨ã„ã†åå‰ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆã—ã¾ã™ã€‚ .nf \f3 .fl \-d docs\-filelist .fl \-use .fl \-splitindex .fl \-windowtitle 'Java SE 7 API Specification' .fl \-doctitle 'Java SE 7 API Specification' .fl \-header '<b>Java(TM) SE 7</b>' .fl \-bottom 'Copyright © 1993\-2011 Oracle and/or its affiliates. All rights reserved.' .fl \-group "Core Packages" "java.*" .fl \-overview /java/pubs/ws/1.7.0/src/share/classes/overview\-core.html .fl \-sourcepath /java/pubs/ws/1.7.0/src/share/classes .fl \fP .fi .LP 次ã®å†…容をå«ã‚€ã€ã€Œ\f2packages\fPã€ã¨ã„ã†åå‰ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆã—ã¾ã™ã€‚ .nf \f3 .fl com.mypackage1 .fl com.mypackage2 .fl com.mypackage3 .fl \fP .fi .LP ãã®å¾Œã€æ¬¡ã®ã‚³ãƒžãƒ³ãƒ‰ã‚’使用ã—ã¦Javadocを実行ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc @options @packages\fP .fl .fi .SS パス付ãã®å¼•æ•°ãƒ•ã‚¡ã‚¤ãƒ«ã®ä¾‹ .LP 引数ファイルã«ã¯ã€ãƒ‘スを指定ã§ãã¾ã™ã€‚ãŸã ã—ã€ãã®ãƒ•ã‚¡ã‚¤ãƒ«å†…ã«æŒ‡å®šã•ã‚ŒãŸãƒ•ã‚¡ã‚¤ãƒ«åã¯ã€ç¾åœ¨ã®ä½œæ¥ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰è¦‹ãŸç›¸å¯¾ãƒ‘スã«ãªã‚Šã¾ã™ã€‚ã¤ã¾ã‚Šã€ä¸‹ã®ä¾‹ã®å ´åˆã¯ã€\f2path1\fPã‚„\f2path2\fPã‹ã‚‰è¦‹ãŸç›¸å¯¾ãƒ‘スã§ã¯ã‚ã‚Šã¾ã›ã‚“。 .nf \f3 .fl % \fP\f3javadoc @path1/options @path2/packages\fP .fl .fi .SS オプションã®å¼•æ•°ã®ä¾‹ .LP 次ã«ã€Javadocオプションã«å¯¾ã™ã‚‹å¼•æ•°ã®ã¿ã‚’引数ファイルã«æ ¼ç´ã™ã‚‹ä¾‹ã‚’示ã—ã¾ã™ã€‚ã“ã“ã§ã¯\f2\-bottom\fPオプションを使用ã—ã¾ã™ã€‚ãã®ã‚ªãƒ—ションã«ã¯ã€é•·ã„引数を指定ã§ãã‚‹ã‹ã‚‰ã§ã™ã€‚次ã®ã‚ˆã†ãªãƒ†ã‚スト引数をå«ã‚€ã€ã€Œ\f2bottom\fPã€ã¨ã„ã†åå‰ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’作æˆã§ãã¾ã™ã€‚ .nf \f3 .fl <font size="\-1"> .fl <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> .fl Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> .fl Oracle is a registered trademark of Oracle Corporation and/or its affiliates. .fl Other names may be trademarks of their respective owners.</font> .fl \fP .fi .LP ãã®å¾Œã€æ¬¡ã®ã‚ˆã†ã«ã—ã¦Javadocツールを実行ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-bottom @bottom @packages\fP .fl .fi .LP ã‚ã‚‹ã„ã¯ã€å¼•æ•°ãƒ•ã‚¡ã‚¤ãƒ«ã®å…ˆé ã«\f2\-bottom\fPオプションを組ã¿è¾¼ã‚“ã 後ã€æ¬¡ã®ã‚ˆã†ã«ã—ã¦å®Ÿè¡Œã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc @bottom @packages\fP .fl .fi .SH "åå‰" 実行 .SH "Javadocã®å®Ÿè¡Œ" .LP \f3ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·\fP \- Javadocã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ã‚’判別ã™ã‚‹ã«ã¯ã€\f3javadoc \-J\-version\fPを使用ã—ã¾ã™ã€‚出力ストリームã«ã¯æ¨™æº–ドックレットã®ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ãŒå«ã¾ã‚Œã¾ã™ã€‚\f2\-quiet\fPã§ç„¡åŠ¹ã«ã§ãã¾ã™ã€‚ .LP \f3公開プãƒã‚°ãƒ©ãƒ ・インタフェース\fP \- Java言語ã§è¨˜è¿°ã•ã‚ŒãŸãƒ—ãƒã‚°ãƒ©ãƒ ã‹ã‚‰Javadocツールを起動ã™ã‚‹ã¨ã使用ã—ã¾ã™ã€‚ã“ã®ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã¯\f2com.sun.tools.javadoc.Main\fPã«ã‚ã‚Šã¾ã™(Javadocã¯å†å…¥å¯èƒ½)。詳細ã¯ã€ .na \f2標準ドックレット\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/standard\-doclet.html#runningprogrammaticallyã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .LP \f3ドックレットã®å®Ÿè¡Œ\fP \- 下ã®èª¬æ˜Žã¯ã€æ¨™æº–HTMLドックレットを呼ã³å‡ºã™ãŸã‚ã®ã‚‚ã®ã§ã™ã€‚カスタム・ドックレットを呼ã³å‡ºã™ã«ã¯ã€\-docletãŠã‚ˆã³\-docletpathオプションを使用ã—ã¾ã™ã€‚詳細ã¯ã€ .na \f2ドックレットã®æ¦‚è¦\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/doclet/overview.htmlã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .SH "ç°¡å˜ãªä¾‹" .LP Javadocã¯ã€ãƒ‘ッケージ全体ã«å¯¾ã—ã¦å®Ÿè¡Œã™ã‚‹ã“ã¨ã‚‚ã€å€‹ã€…ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã«å¯¾ã—ã¦å®Ÿè¡Œã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚å„パッケージåã¯ã€ãã‚Œãžã‚Œã®ãƒ‘ッケージåã«å¯¾å¿œã™ã‚‹ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªåã‚’æŒã¡ã¾ã™ã€‚次ã®ä¾‹ã§ã¯ã€ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã¯\f2/home/src/java/awt/*.java\fPã«ã‚ã‚Šã¾ã™ã€‚生æˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã¯\f2/home/html\fPã§ã™ã€‚ .SS 1ã¤ä»¥ä¸Šã®ãƒ‘ッケージã®ãƒ‰ã‚ュメント化 .LP パッケージをドã‚ュメント化ã™ã‚‹ã«ã¯ã€ãã®ãƒ‘ッケージã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«(\f2*.java\fP)ã‚’ã€ãã®ãƒ‘ッケージã¨åŒã˜åå‰ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªå†…ã«æ ¼ç´ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚パッケージåãŒ(\f2java.awt.color\fPã®ã‚ˆã†ã«ãƒ‰ãƒƒãƒˆã§åŒºåˆ‡ã‚‰ã‚ŒãŸ)複数ã®è˜åˆ¥åã‹ã‚‰æ§‹æˆã•ã‚Œã¦ã„ã‚‹å ´åˆã€å¾Œç¶šã®å„è˜åˆ¥åãŒä¸‹ä½ã®ã‚µãƒ–ディレクトリ(\f2java/awt/color\fPãªã©)ã«å¯¾å¿œã—ã¦ã„ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚1ã¤ã®ãƒ‘ッケージã®ãŸã‚ã®è¤‡æ•°ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’ã€ç•°ãªã‚‹å ´æ‰€ã«ã‚ã‚‹ãã®ã‚ˆã†ãª2ã¤ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªãƒ»ãƒ„リーã«åˆ†ã‘ã¦æ ¼ç´ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™(\f2src1/java/awt/color\fPã‚„\f2src2/java/awt/color\fPãªã©)。ãŸã ã—ã€ãã®å ´åˆã¯\f2\-sourcepath\fPã«ã‚ˆã£ã¦ãã®ä¸¡æ–¹ã®å ´æ‰€ã‚’指定ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã¾ã™ã€‚ .LP Javadocを実行ã™ã‚‹ã«ã¯ã€\f2cd\fPを使用ã—ã¦ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’変更ã™ã‚‹ã‹ã€\f2\-sourcepath\fPオプションを使用ã—ã¾ã™ã€‚次ã®ä¾‹ã§ã¯ã€ä¸¡æ–¹ã®æ–¹æ³•ã«ã¤ã„ã¦èª¬æ˜Žã—ã¾ã™ã€‚ .RS 3 .TP 2 o \f3ケース1 \- 1ã¤ä»¥ä¸Šã®ãƒ‘ッケージã‹ã‚‰ã®èµ·å‹•ã‚’å†å¸°çš„ã«å®Ÿè¡Œ\fP \- ã“ã®ä¾‹ã§ã¯JavadocãŒä»»æ„ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰å®Ÿè¡Œã§ãるよã†ã«ã€\-sourcepathを使用ã—ã€å†å¸°çš„処ç†ã®ãŸã‚ã«\-subpackages(1.4ã®æ–°ã‚ªãƒ—ション)を使用ã—ã¾ã™ã€‚ã“ã‚Œã¯ã€\f2java\fPディレクトリã®ã‚µãƒ–パッケージをãŸã©ã‚Šã¾ã™ãŒã€\f2java.net\fPã¨\f2java.lang\fPをルートã«æŒã¤ãƒ‘ッケージã¯é™¤å¤–ã•ã‚Œã¾ã™ã€‚\f2java.lang\fPã®ã‚µãƒ–パッケージã§ã‚ã‚‹\f2java.lang.ref\fPãŒé™¤å¤–ã•ã‚Œã‚‹ç‚¹ã«æ³¨æ„ã—ã¦ãã ã•ã„。 .nf \f3 .fl % \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 .fl .fi .LP ã¾ãŸã€ä»–ã®ãƒ‘ッケージ・ツリーを下方ã«ãŸã©ã‚‹ã«ã¯ã€\f2java:javax:org.xml.sax\fPã®ã‚ˆã†ã«ã€ãれらã®ãƒ‘ッケージã®åå‰ã‚’\f2\-subpackages\fPã®å¼•æ•°ã«è¿½åŠ ã—ã¾ã™ã€‚ .TP 2 o \f3ケース2 \- ルート・ソース・ディレクトリã«ç§»ã£ã¦ã‹ã‚‰æ˜Žç¤ºçš„ãªãƒ‘ッケージã«å¯¾ã—ã¦å®Ÿè¡Œ\fP \- 完全修飾ã®ãƒ‘ッケージåã®è¦ªãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«ç§»ã‚Šã¾ã™ã€‚次ã«ã€ãƒ‰ã‚ュメント化ã™ã‚‹1ã¤ä»¥ä¸Šã®ãƒ‘ッケージã®åå‰ã‚’指定ã—ã¦Javadocを実行ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3cd /home/src/\fP .fl % \f3javadoc \-d /home/html java.awt java.awt.event\fP .fl .fi .TP 2 o \f3ケース3 \- 1ã¤ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªãƒ»ãƒ„リー内ã«ã‚る明示的ãªãƒ‘ッケージã«å¯¾ã—ã¦ä»»æ„ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰å®Ÿè¡Œ\fP \- ã“ã®ã‚±ãƒ¼ã‚¹ã§ã¯ã€ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªãŒã©ã“ã§ã‚ã£ã¦ã‚‚ã‹ã¾ã„ã¾ã›ã‚“。最上ä½ãƒ‘ッケージã®è¦ªãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’\f2\-sourcepath\fPã«æŒ‡å®šã—ã€ãƒ‰ã‚ュメント化ã™ã‚‹1ã¤ä»¥ä¸Šã®ãƒ‘ッケージåを指定ã—ã¦Javadocを実行ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt java.awt.event\fP .fl .fi .TP 2 o \f3ケース4 \- 複数ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªãƒ»ãƒ„リー内ã«ã‚る明示的ãªãƒ‘ッケージã«å¯¾ã—ã¦ä»»æ„ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰å®Ÿè¡Œ\fP \- ã“ã‚Œã¯ã‚±ãƒ¼ã‚¹3ã¨ä¼¼ã¦ã„ã¾ã™ãŒã€ãƒ‘ッケージãŒè¤‡æ•°ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªãƒ»ãƒ„リーã«å˜åœ¨ã—ã¾ã™ã€‚ãã‚Œãžã‚Œã®ãƒ„リーã®ãƒ«ãƒ¼ãƒˆã¸ã®ãƒ‘スを\f2\-sourcepath\fPã«æŒ‡å®šã—(コãƒãƒ³ã§åŒºåˆ‡ã‚‹)ã€ãƒ‰ã‚ュメント化ã™ã‚‹1ã¤ä»¥ä¸Šã®ãƒ‘ッケージåを指定ã—ã¦Javadocを実行ã—ã¾ã™ã€‚1ã¤ã®ãƒ‘ッケージã®ã™ã¹ã¦ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ãŒã€1ã¤ã®ãƒ«ãƒ¼ãƒˆãƒ»ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã®ä¸‹ã«å˜åœ¨ã™ã‚‹å¿…è¦ã¯ã‚ã‚Šã¾ã›ã‚“。ソース・パスã¨ã—ã¦æŒ‡å®šã•ã‚ŒãŸå ´æ‰€ã®ã©ã“ã‹ã§è¦‹ã¤ã‹ã‚Œã°å分ã§ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java.awt java.awt.event\fP .fl .fi .RE .LP çµæžœ: ã™ã¹ã¦ã®ã‚±ãƒ¼ã‚¹ã§\f2java.awt\fPãŠã‚ˆã³\f2java.awt.event\fPパッケージ内ã®publicãŠã‚ˆã³protectedクラスã¨ã‚¤ãƒ³ã‚¿ãƒ•ã‚§ãƒ¼ã‚¹ã«ã¤ã„ã¦ã€HTMLå½¢å¼ã®ãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã€æŒ‡å®šã•ã‚ŒãŸç”Ÿæˆå…ˆãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒª(\f2/home/html\fP)ã«HTMLファイルãŒä¿å˜ã•ã‚Œã¾ã™ã€‚2ã¤ä»¥ä¸Šã®ãƒ‘ッケージãŒç”Ÿæˆã•ã‚Œã¦ã„ã‚‹ã®ã§ã€ãƒ‰ã‚ュメントã¯ã€ãƒ‘ッケージã®ãƒªã‚¹ãƒˆã€ã‚¯ãƒ©ã‚¹ã®ãƒªã‚¹ãƒˆã€ãŠã‚ˆã³ãƒ¡ã‚¤ãƒ³ã®ã‚¯ãƒ©ã‚¹ãƒ»ãƒšãƒ¼ã‚¸ã¨ã„ã†3ã¤ã®HTMLフレームをæŒã¤ã“ã¨ã«ãªã‚Šã¾ã™ã€‚ .SS 1ã¤ä»¥ä¸Šã®ã‚¯ãƒ©ã‚¹ã®ãƒ‰ã‚ュメント化 .LP ã¾ãŸã€1ã¤ä»¥ä¸Šã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«(\f2.java\fP)を渡ã—ã¦ã€Javadocツールを実行ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚Javadocã¯ã€æ¬¡ã®2ã¤ã®æ–¹æ³•ã®ã„ãšã‚Œã‹ã§å®Ÿè¡Œã§ãã¾ã™ã€‚1ã¤ã¯\f2cd\fPを使用ã—ã¦ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’変更ã™ã‚‹æ–¹æ³•ã€ã‚‚ã†1ã¤ã¯\f2.java\fPファイルã¸ã®ãƒ‘スを完全ã«æŒ‡å®šã™ã‚‹æ–¹æ³•ã§ã™ã€‚相対パスã¯ã€ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‚’起点ã¨ã—ã¾ã™ã€‚ソース・ファイルを渡ã™ã¨ãã¯ã€\f2\-sourcepath\fPオプションã¯ç„¡è¦–ã•ã‚Œã¾ã™ã€‚アスタリスク(*)ã®ã‚ˆã†ãªã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ãƒ»ãƒ¯ã‚¤ãƒ«ãƒ‰ã‚«ãƒ¼ãƒ‰ã‚’使用ã™ã‚‹ã¨ã€ã‚¯ãƒ©ã‚¹ã®ã‚°ãƒ«ãƒ¼ãƒ—を指定ã§ãã¾ã™ã€‚ .RS 3 .TP 2 o \f3ケース1 \- ソース・ディレクトリã«ç§»ã‚‹\fP \- \f2.java\fPファイルã®ã‚るディレクトリã«ç§»ã‚Šã¾ã™ã€‚次ã«ã€ãƒ‰ã‚ュメント化ã™ã‚‹1ã¤ä»¥ä¸Šã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã®åå‰ã‚’指定ã—ã¦Javadocを実行ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3cd /home/src/java/awt\fP .fl % \f3javadoc \-d /home/html Button.java Canvas.java Graphics*.java\fP .fl .fi ã“ã®ä¾‹ã§ã¯ã€\f2Button\fPクラスã¨\f2Canvas\fPクラスã€ãŠã‚ˆã³åå‰ãŒ\f2Graphics\fPã§å§‹ã¾ã‚‹ã‚¯ãƒ©ã‚¹ã«ã¤ã„ã¦ã€HTMLå½¢å¼ã®ãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚パッケージåã§ã¯ãªãソース・ファイルãŒJavadocã«å¼•æ•°ã¨ã—ã¦æ¸¡ã•ã‚Œã¦ã„ã‚‹ã®ã§ã€ãƒ‰ã‚ュメントã¯ã€ã‚¯ãƒ©ã‚¹ã®ãƒªã‚¹ãƒˆã¨ãƒ¡ã‚¤ãƒ³ãƒ»ãƒšãƒ¼ã‚¸ã¨ã„ã†2ã¤ã®ãƒ•ãƒ¬ãƒ¼ãƒ ã‚’æŒã¤ã“ã¨ã«ãªã‚Šã¾ã™ã€‚ .TP 2 o \f3ケース2 \- パッケージã®ãƒ«ãƒ¼ãƒˆãƒ»ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«ç§»ã‚‹\fP \- ã“ã‚Œã¯ã€åŒã˜ãƒ«ãƒ¼ãƒˆå†…ã«ã‚る複数ã®ã‚µãƒ–パッケージã®å€‹ã€…ã®ã‚½ãƒ¼ã‚¹ãƒ»ãƒ•ã‚¡ã‚¤ãƒ«ã‚’ドã‚ュメント化ã™ã‚‹å ´åˆã«ä¾¿åˆ©ã§ã™ã€‚パッケージã®ãƒ«ãƒ¼ãƒˆãƒ»ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«ç§»ã‚Šã€å„ソース・ファイルをã€ãƒ«ãƒ¼ãƒˆã‹ã‚‰ã®ãƒ‘スã¨ã¨ã‚‚ã«æŒ‡å®šã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3cd /home/src/\fP .fl % \f3javadoc \-d /home/html java/awt/Button.java java/applet/Applet.java\fP .fl .fi ã“ã®ä¾‹ã§ã¯ã€\f2Button\fPクラスãŠã‚ˆã³\f2Applet\fPクラスã«ã¤ã„ã¦ã€HTMLå½¢å¼ã®ãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚ .TP 2 o \f3ケース3 \- ä»»æ„ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰\fP \- ã“ã®ã‚±ãƒ¼ã‚¹ã§ã¯ã€ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªãŒã©ã“ã§ã‚ã£ã¦ã‚‚ã‹ã¾ã„ã¾ã›ã‚“。ドã‚ュメント化ã™ã‚‹\f2.java\fPファイルã¸ã®çµ¶å¯¾ãƒ‘ス(ã¾ãŸã¯ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰ã®ç›¸å¯¾ãƒ‘ス)を指定ã—ã¦Javadocを実行ã—ã¾ã™ã€‚ .nf \f3 .fl % \fP\f3javadoc \-d /home/html /home/src/java/awt/Button.java /home/src/java/awt/Graphics*.java\fP .fl .fi ã“ã®ä¾‹ã§ã¯ã€\f2Button\fPクラスã€ãŠã‚ˆã³åå‰ãŒ\f2Graphics\fPã§å§‹ã¾ã‚‹ã‚¯ãƒ©ã‚¹ã«ã¤ã„ã¦ã€HTMLå½¢å¼ã®ãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚ .RE .SS パッケージã¨ã‚¯ãƒ©ã‚¹ã®ãƒ‰ã‚ュメント化 .LP パッケージ全体ã¨å€‹ã€…ã®ã‚¯ãƒ©ã‚¹ã‚’åŒæ™‚ã«æŒ‡å®šã—ã¦ãƒ‰ã‚ュメント化ã™ã‚‹ã“ã¨ã‚‚ã§ãã¾ã™ã€‚次ã«ã€å‰è¿°ã®2ã¤ã®ä¾‹ã‚’組ã¿åˆã›ãŸä¾‹ã‚’示ã—ã¾ã™ã€‚\f2\-sourcepath\fPã¯ã€ãƒ‘ッケージã¸ã®ãƒ‘スã«å¯¾ã—ã¦ã¯ä½¿ç”¨ã§ãã¾ã™ãŒã€å€‹ã€…ã®ã‚¯ãƒ©ã‚¹ã¸ã®ãƒ‘スã«å¯¾ã—ã¦ã¯ä½¿ç”¨ã§ãã¾ã›ã‚“。 .nf \f3 .fl % \fP\f3javadoc \-d /home/html \-sourcepath /home/src java.awt /home/src/java/applet/Applet.java\fP .fl .fi .LP ã“ã®ä¾‹ã§ã¯ã€\f2java.awt\fPパッケージãŠã‚ˆã³\f2Applet\fPクラスã«ã¤ã„ã¦ã€HTMLå½¢å¼ã®ãƒ‰ã‚ュメントãŒç”Ÿæˆã•ã‚Œã¾ã™ã€‚(Javadocツールã¯ã€\f2Applet.java\fPソース・ファイル内ã«ãƒ‘ッケージ宣言ãŒã‚ã‚Œã°ã€ãã®å®£è¨€ã«åŸºã¥ã„ã¦\f2Applet\fPã®ãƒ‘ッケージåを判別ã—ã¾ã™ã€‚) .SH "使用例" .LP Javadocツールã«ã¯å¤šãã®ä¾¿åˆ©ãªã‚ªãƒ—ションãŒã‚ã‚Šã€ãã®ä¸ã«ã¯ä»–ã®ã‚ªãƒ—ã‚·ãƒ§ãƒ³ã‚ˆã‚Šã‚‚é »ç¹ã«ä½¿ç”¨ã•ã‚Œã‚‹ã‚‚ã®ãŒã‚ã‚Šã¾ã™ã€‚ã“ã“ã§ç´¹ä»‹ã™ã‚‹ã®ã¯ã€JavaプラットフォームAPIã«å¯¾ã—ã¦Javadocツールを実行ã™ã‚‹ã¨ãã«ä½¿ç”¨ã™ã‚‹å®Ÿéš›ã®ã‚³ãƒžãƒ³ãƒ‰ã§ã™ã€‚Java SE Platform, Standard Edition, v1.2ã«å˜åœ¨ã™ã‚‹ã€ç´„1500個ã®publicãŠã‚ˆã³protectedクラスã®ãƒ‰ã‚ュメントを生æˆã™ã‚‹ãŸã‚ã«ã€180MBã®ãƒ¡ãƒ¢ãƒªãƒ¼ã‚’使用ã—ã¾ã™ã€‚ .LP åŒã˜ä¾‹ã‚’2回掲載ã—ã¾ã™ã€‚最åˆã®ä¾‹ã¯ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³ã‹ã‚‰å®Ÿè¡Œã™ã‚‹ã‚‚ã®ã§ã€2番目ã®ä¾‹ã¯Makefileã‹ã‚‰å®Ÿè¡Œã™ã‚‹ã‚‚ã®ã§ã™ã€‚オプションã®å¼•æ•°ã§çµ¶å¯¾ãƒ‘スãŒä½¿ç”¨ã•ã‚Œã¦ã„ã‚‹ãŸã‚ã€ä»»æ„ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã‹ã‚‰åŒã˜\f2javadoc\fPコマンドを実行ã§ãã¾ã™ã€‚ .SS コマンドラインã®ä¾‹ .LP 次ã®ä¾‹ã¯ã€DOSãªã©ã®ä¸€éƒ¨ã®ã‚·ã‚§ãƒ«ã«ã¯é•·ã™ãŽã¾ã™ã€‚ã“ã®åˆ¶é™ã‚’回é¿ã™ã‚‹ã«ã¯ã€ã‚³ãƒžãƒ³ãƒ‰ãƒ©ã‚¤ãƒ³å¼•æ•°ãƒ•ã‚¡ã‚¤ãƒ«ã‚’使用ã—ã¾ã™ã€‚ã¾ãŸã¯ã€ã‚·ã‚§ãƒ«ãƒ»ã‚¹ã‚¯ãƒªãƒ—トを記述ã—ã¾ã™ã€‚ .nf \f3 .fl % javadoc \-sourcepath /java/jdk/src/share/classes \\ .fl \-overview /java/jdk/src/share/classes/overview.html \\ .fl \-d /java/jdk/build/api \\ .fl \-use \\ .fl \-splitIndex \\ .fl \-windowtitle 'Java Platform, Standard Edition 7 API Specification' \\ .fl \-doctitle 'Java Platform, Standard Edition 7 API Specification' \\ .fl \-header '<b>Java(TM) SE 7</b>' \\ .fl \-bottom '<font size="\-1"> .fl <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> .fl Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> .fl Oracle is a registered trademark of Oracle Corporation and/or its affiliates. .fl Other names may be trademarks of their respective owners.</font>' \\ .fl \-group "Core Packages" "java.*:com.sun.java.*:org.omg.*" \\ .fl \-group "Extension Packages" "javax.*" \\ .fl \-J\-Xmx180m \\ .fl @packages .fl \fP .fi .LP ã“ã“ã§ã€\f2packages\fPã¯ã€å‡¦ç†å¯¾è±¡ã®ãƒ‘ッケージå(\f2java.applet java.lang\fPãªã©)ãŒå…¥ã£ã¦ã„るファイルã®åå‰ã§ã™ã€‚å„オプションã®ã€ä¸€é‡å¼•ç”¨ç¬¦ã§å›²ã¾ã‚ŒãŸå¼•æ•°ã®å†…å´ã«ã¯ã€æ”¹è¡Œæ–‡å—を挿入ã§ãã¾ã›ã‚“。(ãŸã¨ãˆã°ã€ã“ã®ä¾‹ã‚’コピー&ペーストã™ã‚‹å ´åˆã¯ã€\f2\-bottom\fPオプションã‹ã‚‰æ”¹è¡Œæ–‡å—を削除ã—ã¦ãã ã•ã„。)ã•ã‚‰ã«ã€ä¸‹ã®ã€Œæ³¨æ„ã€ã‚‚å‚ç…§ã—ã¦ãã ã•ã„。 .SS Makefileã®ä¾‹ .LP ã“ã“ã§ã¯ã€GNU Makefileã®ä¾‹ã‚’示ã—ã¾ã™ã€‚Windowsã®Makefileã®ä¾‹ã«ã¤ã„ã¦ã¯ã€ .na \f2Windowsã®Makefileã®ä½œæˆæ–¹æ³•\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137483.html#makefilesã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .nf \f3 .fl javadoc \-\fP\f3sourcepath\fP\f3 $(SRCDIR) \\ /* Sets path for source files */ .fl \-\fP\f3overview\fP\f3 $(SRCDIR)/overview.html \\ /* Sets file for overview text */ .fl \-\fP\f3d\fP\f3 /java/jdk/build/api \\ /* Sets destination directory */ .fl \-\fP\f3use\fP\f3 \\ /* Adds "Use" files */ .fl \-\fP\f3splitIndex\fP\f3 \\ /* Splits index A\-Z */ .fl \-\fP\f3windowtitle\fP\f3 $(WINDOWTITLE) \\ /* Adds a window title */ .fl \-\fP\f3doctitle\fP\f3 $(DOCTITLE) \\ /* Adds a doc title */ .fl \-\fP\f3header\fP\f3 $(HEADER) \\ /* Adds running header text */ .fl \-\fP\f3bottom\fP\f3 $(BOTTOM) \\ /* Adds text at bottom */ .fl \-\fP\f3group\fP\f3 $(GROUPCORE) \\ /* 1st subhead on overview page */ .fl \-\fP\f3group\fP\f3 $(GROUPEXT) \\ /* 2nd subhead on overview page */ .fl \-\fP\f3J\fP\f3\-Xmx180m \\ /* Sets memory to 180MB */ .fl java.lang java.lang.reflect \\ /* Sets packages to document */ .fl java.util java.io java.net \\ .fl java.applet .fl .fl WINDOWTITLE = 'Java(TM) SE 7 API Specification' .fl DOCTITLE = 'Java(TM) Platform Standard Edition 7 API Specification' .fl HEADER = '<b>Java(TM) SE 7</font>' .fl BOTTOM = '<font size="\-1"> .fl <a href="http://bugreport.sun.com/bugreport/">Submit a bug or feature</a><br/> .fl Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.<br/> .fl Oracle is a registered trademark of Oracle Corporation and/or its affiliates. .fl Other names may be trademarks of their respective owners.</font>' .fl GROUPCORE = '"Core Packages" "java.*:com.sun.java.*:org.omg.*"' .fl GROUPEXT = '"Extension Packages" "javax.*"' .fl SRCDIR = '/java/jdk/1.7.0/src/share/classes' .fl \fP .fi .LP Makefileã®å¼•æ•°ã¯ã€ä¸€é‡å¼•ç”¨ç¬¦ã§å›²ã¿ã¾ã™ã€‚ .LP \f3注æ„\fP .RS 3 .TP 2 o \f2\-windowtitle\fPオプションをçœç•¥ã™ã‚‹ã¨ã€Javadocツールã«ã‚ˆã£ã¦ãƒ‰ã‚ュメント・タイトルãŒã‚¦ã‚£ãƒ³ãƒ‰ã‚¦ãƒ»ã‚¿ã‚¤ãƒˆãƒ«ã«ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚\f2\-windowtitle\fPã®ãƒ†ã‚ストã¯ã€åŸºæœ¬çš„ã«\f2\-doctitle\fPã¨åŒã˜ã§ã™ã€‚ãŸã ã—ã€HTMLã‚¿ã‚°ã¯å«ã¾ã‚Œã¾ã›ã‚“。ã“ã‚Œã¯ã€HTMLã‚¿ã‚°ãŒã€ã‚¦ã‚£ãƒ³ãƒ‰ã‚¦ãƒ»ã‚¿ã‚¤ãƒˆãƒ«å†…ã«ãã®ã¾ã¾ã®ãƒ†ã‚ストã¨ã—ã¦è¡¨ç¤ºã•ã‚Œã‚‹ã®ã‚’防ããŸã‚ã§ã™ã€‚. .TP 2 o ã“ã®ä¾‹ã®ã‚ˆã†ã«\f2\-footer\fPオプションをçœç•¥ã™ã‚‹ã¨ã€Javadocツールã«ã‚ˆã£ã¦ãƒ˜ãƒƒãƒ€ãƒ¼ãƒ»ãƒ†ã‚ストãŒãƒ•ãƒƒã‚¿ãƒ¼ã«ã‚³ãƒ”ーã•ã‚Œã¾ã™ã€‚ .TP 2 o ã“ã®ä¾‹ã§ã¯å¿…è¦ã‚ã‚Šã¾ã›ã‚“ãŒã€\f2\-classpath\fPã¨\f2\-link\fPã‚‚é‡è¦ãªã‚ªãƒ—ションã§ã™ã€‚ .RE .SH "トラブルシューティング" .SS 一般的ãªãƒˆãƒ©ãƒ–ルシューティング .RS 3 .TP 2 o \f3Javadocã®FAQ\fP \- 一般的ãªãƒã‚°ãŠã‚ˆã³ãƒˆãƒ©ãƒ–ルシューティングã®ãƒ’ントã¯ã€ .na \f2Javadocã®FAQ\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137483.htmlã§å‚ç…§ã§ãã¾ã™ã€‚ .TP 2 o \f3ãƒã‚°ãŠã‚ˆã³åˆ¶é™äº‹é …\fP \- ãƒã‚°ã®ä¸€éƒ¨ã¯ã€ãƒã‚°ä¿®æ£ãŠã‚ˆã³å¤‰æ›´ã®ã‚¤ãƒ³ãƒãƒ¼ãƒˆã§ã‚‚å‚ç…§ã§ãã¾ã™ã€‚ .TP 2 o \f3ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·\fP \- ãƒãƒ¼ã‚¸ãƒ§ãƒ³ç•ªå·ã‚’å‚ç…§ã—ã¦ãã ã•ã„。 .TP 2 o \f3有効ãªã‚¯ãƒ©ã‚¹ã®ã¿ã‚’ドã‚ュメント化\fP \- パッケージをドã‚ュメント化ã™ã‚‹ã¨ãã€Javadocã¯ã€åå‰ãŒæœ‰åŠ¹ãªã‚¯ãƒ©ã‚¹åã§æ§‹æˆã•ã‚Œã¦ã„るファイルã®ã¿ã‚’èªã¿è¾¼ã¿ã¾ã™ã€‚ãŸã¨ãˆã°ã€ãƒ•ã‚¡ã‚¤ãƒ«åã«ãƒã‚¤ãƒ•ãƒ³ã€Œ\-ã€ã‚’å«ã‚ã‚‹ã“ã¨ã§ã€Javadocã«ã‚ˆã‚‹ãƒ•ã‚¡ã‚¤ãƒ«ã®è§£æžã‚’防ãã“ã¨ãŒã§ãã¾ã™ã€‚ .RE .SS エラーã¨è¦å‘Š .LP エラーãŠã‚ˆã³è¦å‘Šãƒ¡ãƒƒã‚»ãƒ¼ã‚¸ã«ã¯ã€ãƒ•ã‚¡ã‚¤ãƒ«åã¨å®£è¨€è¡Œ(ドã‚ュメンテーション・コメント内ã®ç‰¹å®šã®è¡Œã§ã¯ãªã„)ã®è¡Œç•ªå·ãŒå«ã¾ã‚Œã¾ã™ã€‚ .RS 3 .TP 2 o 「\f2エラー: Class1.javaã‚’èªã¿è¾¼ã‚ã¾ã›ã‚“\fPã€: Javadocツールã¯ç¾åœ¨ã®ãƒ‡ã‚£ãƒ¬ã‚¯ãƒˆãƒªã«Class1.javaクラスをãƒãƒ¼ãƒ‰ã—よã†ã¨ã—ã¦ã„ã¾ã™ã€‚絶対パスã¾ãŸã¯ç›¸å¯¾ãƒ‘スã¨ã¨ã‚‚ã«è¡¨ç¤ºã•ã‚Œã‚‹ã‚¯ãƒ©ã‚¹åã¯ã€ã“ã®ä¾‹ã®å ´åˆ\f2./Class1.java\fPã¨åŒã˜ã§ã™ã€‚ .RE .SH "環境" .RS 3 .TP 3 CLASSPATH JavadocãŒãƒ¦ãƒ¼ã‚¶ãƒ¼ãƒ»ã‚¯ãƒ©ã‚¹ã®ãƒ•ã‚¡ã‚¤ãƒ«ã‚’探ã™ã¨ãã«ä½¿ç”¨ã™ã‚‹ãƒ‘スを指定ã™ã‚‹ç’°å¢ƒå¤‰æ•°ã§ã™ã€‚ã“ã®ç’°å¢ƒå¤‰æ•°ã¯ã€\f2\-classpath\fPオプションã«ã‚ˆã£ã¦ã‚ªãƒ¼ãƒãƒ¼ãƒ©ã‚¤ãƒ‰ã•ã‚Œã¾ã™ã€‚ディレクトリã¯ã€æ¬¡ã®ã‚ˆã†ã«ã‚³ãƒãƒ³ã§åŒºåˆ‡ã‚Šã¾ã™ã€‚ .:/home/classes:/usr/local/java/classes .RE .SH "é–¢é€£é …ç›®" .RS 3 .TP 2 o javac(1) .TP 2 o java(1) .TP 2 o jdb(1) .TP 2 o javah(1) .TP 2 o javap(1) .TP 2 o .na \f2Javadocã®ãƒ›ãƒ¼ãƒ ・ページ\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-jsp\-135444.html .TP 2 o .na \f2How to Write Doc Comments for Javadoc\fP @ .fi http://www.oracle.com/technetwork/java/javase/documentation/index\-137868.html .TP 2 o .na \f2クラス・パスã®è¨å®š\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/tools/index.html#general .TP 2 o .na \f2javacã¨javadocãŒã‚¯ãƒ©ã‚¹ã‚’検索ã™ã‚‹æ–¹æ³•\fP @ .fi http://docs.oracle.com/javase/7/docs/technotes/tools/findingclasses.html#srcfiles(tools.jar) .RE