blob: c986e3d68ff0fc2136d682d0d4c4d5cbe89096ed [file] [log] [blame]
'\" t
.\" Copyright 2006 Sun Microsystems, Inc. All Rights Reserved.
.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
.\"
.\" This code is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License version 2 only, as
.\" published by the Free Software Foundation.
.\"
.\" This code is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
.\" version 2 for more details (a copy is included in the LICENSE file that
.\" accompanied this code).
.\"
.\" You should have received a copy of the GNU General Public License version
.\" 2 along with this work; if not, write to the Free Software Foundation,
.\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
.\"
.\" Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
.\" CA 95054 USA or visit www.sun.com if you need additional information or
.\" have any questions.
.\" `
.TH javadoc 1 "2006 ǯ 9 ·î 4 Æü" "Java SE 6" "¥æ¡¼¥¶¡¼¥³¥Þ¥ó¥É"
.hw javadoc
.SH "̾Á°"
javadoc \- Java API ¥É¥­¥å¥á¥ó¥È¥¸¥§¥Í¥ì¡¼¥¿
.RS 3
.LP
.LP
Java ¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤«¤é¡¢API ¥É¥­¥å¥á¥ó¥È¤Î HTML ¥Ú¡¼¥¸¤òÀ¸À®¤·¤Þ¤¹¡£¤³¤Î¥É¥­¥å¥á¥ó¥È¤Ç¾Ò²ð¤µ¤ì¤Æ¤¤¤ë Javadoc ¤ÎÎã¤Ï¡¢Sun Solaris ¤ò»ÈÍѤ·¤¿¾ì¹ç¤Î¤â¤Î¤Ç¤¹¡£
.LP
.SH "·Á¼°"
.B javadoc
[
.I options
] [
.I packagenames
] [
.I sourcefilenames
] [
.I \-subpackages pkg1:pkg2:...
] [
.I @argfiles
]
.LP
.LP
°ú¿ô¤ò»ØÄꤹ¤ë½ç½ø¤ÏǤ°Õ¤Ç¤¹¡£Javadoc ¥Ä¡¼¥ë¤Ç¤Î¡¢½èÍýÂоݤΠ\f2.java\fP ¥Õ¥¡¥¤¥ë¤ò·èÄꤹ¤ëÊýË¡¤Î¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢¡Ö¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î½èÍý¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP 15
.I options
¤³¤Î¥É¥­¥å¥á¥ó¥È¤Ç»ØÄꤵ¤ì¤Æ¤¤¤ë¥³¥Þ¥ó¥É¹Ô¥ª¥×¥·¥ç¥ó¤Ç¤¹¡£
.B javadoc
¤Î¥ª¥×¥·¥ç¥ó¤Î°ìÈÌŪ¤Ê»ÈÍÑË¡¤Ë¤Ä¤¤¤Æ¤Ï¡¢¡Ö»ÈÍÑÎã¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP
.I packagenames
.BR "java.lang java.lang.reflect java.awt"
¤Ê¤É¤Î¡¢¥¹¥Ú¡¼¥¹¤Ç¶èÀÚ¤é¤ì¤¿
°ìÏ¢¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Ç¤¹¡£¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¥Ñ¥Ã¥±¡¼¥¸¤´¤È¤ËÊ̸ĤË
»ØÄꤹ¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¤³¤ì¤é¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤òõ¤¹¤È¤­¡¢
.B \-sourcepath
¤ò»ÈÍѤ·¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤òºÆµ¢Åª¤Ë½èÍý¤¹¤ë¤³¤È¤Ï¤¢¤ê¤Þ¤»¤ó¡£
¥¢¥¹¥¿¥ê¥¹¥¯ (\f3*\f1) ¤Ê¤É¤Î¥ï¥¤¥ë¥É¥«¡¼¥É¤Ï»È¤¦¤³¤È¤¬¤Ç¤­¤Þ¤»¤ó¡£
¡Ö1 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥É¥­¥å¥á¥ó¥È²½¡×¤Î
Îã¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP
.I sourcefilenames
¥¹¥Ú¡¼¥¹¤Ç¶èÀÚ¤é¤ì¤¿°ìÏ¢¤Î¥Õ¥¡¥¤¥ë̾¤Ç¤¹¡£¥Ñ¥¹¡¢¤ª¤è¤Ó
¥¢¥¹¥¿¥ê¥¹¥¯ (\f3*\f1) ¤Ê¤É¤Î¥ï¥¤¥ë¥É¥«¡¼¥É¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤¬½èÍý¤¹¤ë¤Î¤Ï¡¢¥Õ¥¡¥¤¥ë̾¤¬¡Ö.java¡×¤È¤¤¤¦³ÈÄ¥»Ò¤Ç½ª¤ï¤ê¡¢
¤½¤Î³ÈÄ¥»Ò¤ò½ü¤¤¤¿Ì¾Á°¤¬¼ÂºÝ¤ËÍ­¸ú¤Ê¥¯¥é¥¹Ì¾
.fi
(http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625
¤Î
.na
¡Ö\f2Identifiers\fP¡×¤ò»²¾È) ¤Ç¤¢¤ë¤¹¤Ù¤Æ¤Î¥Õ¥¡¥¤¥ë¤Ç¤¹¡£
¤·¤¿¤¬¤Ã¤Æ¡¢¥Ï¥¤¥Õ¥ó¤ò´Þ¤à̾Á° (X-Buffer ¤Ê¤É) ¤ä¡¢
¤½¤Î¾¤Î̵¸ú¤Êʸ»ú¤ò´Þ¤à̾Á°¤òÉÕ¤±¤ë¤³¤È¤Ë¤è¤Ã¤Æ¡¢
¤½¤ì¤é¤Î¥Õ¥¡¥¤¥ë¤ò¥É¥­¥å¥á¥ó¥È²½¤ÎÂоݤ«¤é½ü³°¤Ç¤­¤Þ¤¹¡£
¤³¤ì¤Ï¡¢¥Æ¥¹¥ÈÍѤΥե¡¥¤¥ë¤ä¡¢¥Æ¥ó¥×¥ì¡¼¥È¤«¤éÀ¸À®¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤Î¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤ÎÁ°¤Ë»ØÄꤵ¤ì¤¿¥Ñ¥¹¤ò»ÈÍѤ·¤Æ¡¢
¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤òõ¤·¤Þ¤¹¡£¤³¤Î¾ì¹ç¡¢
.B -sourcepath
¤Ï»ÈÍѤ·¤Þ¤»¤ó¡£¤¿¤È¤¨¤Ð¡¢
.B Button.java
¤òÅϤ¹¤³¤È¤Ï
.BR ./Button.java
¤È»ØÄꤹ¤ë¤³¤È¤ÈƱ¤¸¤Ç¤¹¡£´°Á´¥Ñ¥¹¤òÉÕ¤±¤¿¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤Î
Îã¤Ï¡Ö
.BR /home/src/java/awt/Graphics*.java
¡×¤Î¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£¡Ö1 ¤Ä°Ê¾å¤Î¥¯¥é¥¹¤Î¥É¥­¥å¥á¥ó¥È²½¡×¤ÎÎã¤ò
»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£¤Þ¤¿¡¢¡Ö¥Ñ¥Ã¥±¡¼¥¸¤È¥¯¥é¥¹¤Î¥É¥­¥å¥á¥ó¥È²½¡×¤Î
Îã¤Î¤è¤¦¤Ë¡¢¥Ñ¥Ã¥±¡¼¥¸Ì¾¤È¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤òÁȤ߹ç¤ï¤»¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
.TP
.I \-subpackages pkg1:pkg2:...
»ØÄꤵ¤ì¤¿¥Ñ¥Ã¥±¡¼¥¸Æâ¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤«¤é¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¡¢
ºÆµ¢Åª¤Ë¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤ò½èÍý¤·¤Þ¤¹¡£ ¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Þ¤¿¤Ï
¥½¡¼¥ë¥Õ¥¡¥¤¥ë̾¤ò»ØÄꤹ¤ë¤¿¤á¤ÎÂåÂؼêÃʤǤ¹¡£
.TP
.I @argfiles
Javadoc ¥ª¥×¥·¥ç¥ó¡¢¥Ñ¥Ã¥±¡¼¥¸Ì¾¡¢¤ª¤è¤Ó¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤ò
Ǥ°Õ¤Î½ç½ø¤Çʤ٤¿¥ê¥¹¥È¤¬´Þ¤Þ¤ì¤ë 1 ¤Ä°Ê¾å¤Î¥Õ¥¡¥¤¥ë¤Ç¤¹¡£
¤³¤Î¥Õ¥¡¥¤¥ë¤ÎÃæ¤Ç¤Ï¡¢¥ï¥¤¥ë¥É¥«¡¼¥É (*) ¤ª¤è¤Ó
.B \-J
¥ª¥×¥·¥ç¥ó¤Ï»ØÄê¤Ç¤­¤Þ¤»¤ó¡£
.SH "µ¡Ç½ÀâÌÀ"
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢°ìÏ¢¤Î Java ¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ÎÀë¸À¤ª¤è¤Ó¥É¥­¥å¥á¥ó¥È
¥³¥á¥ó¥È¤ò²òÀϤ·¡¢¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï public ¥¯¥é¥¹¤È protected ¥¯¥é¥¹¡¢
Æþ¤ì»Ò¥¯¥é¥¹¡Êƿ̾¤ÎÆâÉô¥¯¥é¥¹¤ò½ü¤¯¡Ë¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¤ª¤è¤Ó
¥Õ¥£¡¼¥ë¥É¤Ë¤Ä¤¤¤ÆÀâÌÀ¤·¤¿°ìÏ¢¤Î HTML ¥Ú¡¼¥¸¤òÀ¸À®¤·¤Þ¤¹¡£¤Þ¤¿¡¢API (¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¥×¥í¥°¥é¥ß¥ó¥°¥¤¥ó¥¿¥Õ¥§¡¼¥¹) ¥É¥­¥å¥á¥ó¥È¤ÎÀ¸À®¤ä¡¢°ìÏ¢¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¼ÂÁõ¥É¥­¥å¥á¥ó¥È¤ÎÀ¸À®¤Ë»ÈÍѤǤ­¤Þ¤¹¡£
.LP
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸Á´ÂΡ¢¸Ä¡¹¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¡¢¤Þ¤¿¤Ï¤½¤ÎξÊý¤ËÂФ·¤Æ
¼Â¹Ô¤Ç¤­¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤ò¥Ñ¥Ã¥±¡¼¥¸Á´ÂΤËÂФ·¤Æ¼Â¹Ô¤¹¤ë¾ì¹ç¤Ï¡¢ºÇ¾å°Ì¥Ç¥£¥ì¥¯¥È¥ê¤«¤éºÆµ¢Åª¤Ë¤¿¤É¤ë¤¿¤á¤Ë -subpackages ¤ò»ÈÍѤ¹¤ë¤«¡¢¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ÎÌÀ¼¨Åª¤Ê¥ê¥¹¥È¤òÅϤ·¤Þ¤¹¡£
¸Ä¡¹¤Î¥¯¥é¥¹¤ËÂФ·¤Æ javadoc ¤ò¼Â¹Ô¤¹¤ë¾ì¹ç¤Ï¡¢°ìÏ¢¤Î
¥½¡¼¥¹ (\f3.java\f1) ¥Õ¥¡¥¤¥ë̾¤òÅϤ·¤Þ¤¹¡£¶ñÂÎŪ¤ÊÎã¤Ï¡¢
¤³¤Î¥Ú¡¼¥¸¤ÎºÇ¸å¤Ç¼¨¤·¤Þ¤¹¡£
¼¡¤Ë¡¢Javadoc ¤Ë¤è¤ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î½èÍý¤Ë¤Ä¤¤¤ÆÀâÌÀ¤·¤Þ¤¹¡£
.LP
.SS
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î½èÍý
.LP
.LP
Javadoc ¥Ä¡¼¥ë¤Ï¡¢ËöÈø¤Ë \f2.java\fP ¤ÎÉÕ¤¤¤¿¥Õ¥¡¥¤¥ë°Ê³°¤Ë¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ÇÀâÌÀ¤¹¤ë¾¤Î¥Õ¥¡¥¤¥ë¤â½èÍý¤·¤Þ¤¹¡£¸Ä¡¹¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤òÌÀ¼¨Åª¤ËÅϤ¹¤³¤È¤Ë¤è¤Ã¤Æ Javadoc ¥Ä¡¼¥ë¤ò¼Â¹Ô¤¹¤ë¾ì¹ç¡¢\f2.java\fP ¥Õ¥¡¥¤¥ë¤ò½èÍý¤¹¤ë¤«¤òÀµ³Î¤Ë»ØÄê¤Ç¤­¤Þ¤¹¡£¤¿¤À¤·¡¢Â¿¤¯¤Î³«È¯¼Ô¤Ï¤³¤ÎÊýË¡¤Ç¤Ïºî¶È¤·¤Þ¤»¤ó¡£¥Ñ¥Ã¥±¡¼¥¸Ì¾¤òÅϤ¹¤Û¤¦¤¬´Êñ¤À¤«¤é¤Ç¤¹¡£¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤òÌÀ¼¨Åª¤Ë»ØÄꤷ¤Ê¤¯¤Æ¤â¡¢Javadoc ¥Ä¡¼¥ë¤Ï 3 ¤Ä¤ÎÊýË¡¤Ç¼Â¹Ô¤Ç¤­¤Þ¤¹¡£¤³¤ÎÊýË¡¤Ï¡¢(1) ¥Ñ¥Ã¥±¡¼¥¸Ì¾¤òÅϤ¹¡¢(2) \f2\-subpackages\fP ¤ò»ÈÍѤ¹¤ë¡¢(3) ¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤Ë¥ï¥¤¥ë¥É¥«¡¼¥É¤ò»ÈÍѤ¹¤ë (\f2*.java\fP) ¤È¤¤¤¦ÊýË¡¤Ç¤¹¡£¤³¤ì¤é¤ÎÊýË¡¤ò»ÈÍѤ¹¤ë¾ì¹ç¡¢Javadoc ¥Ä¡¼¥ë¤Ï¡¢\f2*.java\fP ¥Õ¥¡¥¤¥ë¤¬¼¡¤Î¤¹¤Ù¤Æ¤ÎÍ×·ï¤òËþ¤¿¤·¤Æ¤¤¤ë¾ì¹ç¤Ë¤«¤®¤ê¡¢¤³¤Î¥Õ¥¡¥¤¥ë¤ò½èÍý¤·¤Þ¤¹¡£
.LP
.RS 3
.TP 2
o
̾Á°¤«¤é \f2.java\fP ¤ÎÀÜÈø¼­¤ò¼è¤ê½ü¤¯¤È¡¢¼ÂºÝ¤ËÍ­¸ú¤Ê¥¯¥é¥¹Ì¾¤Ë¤Ê¤Ã¤Æ¤¤¤ë (Í­¸ú¤Êʸ»ú¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625
¤Î
.na
¡Ö\f2Identifiers\fP¡×¤ò»²¾È)
.TP 2
o
¥½¡¼¥¹¥Ä¥ê¡¼¤Î¥ë¡¼¥È¤«¤éÁêÂÐŪ¤Ê¥Ç¥£¥ì¥¯¥È¥ê¥Ñ¥¹¤¬¡¢¶èÀÚ¤êʸ»ú¤ò¥É¥Ã¥È¤ËÊÑ´¹¤¹¤ë¤È¡¢¼ÂºÝ¤ËÍ­¸ú¤Ê¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Ë¤Ê¤Ã¤Æ¤¤¤ë
.TP 2
o
¥Ñ¥Ã¥±¡¼¥¸Ê¸¤Ë¤ÏÍ­¸ú¤Ê¥Ñ¥Ã¥±¡¼¥¸Ì¾¤¬´Þ¤Þ¤ì¤ë (Á°¹àÌܤǻØÄê)
.RE
.LP
.LP
\f3¥ê¥ó¥¯¤Î½èÍý\fP \-
¼Â¹Ô»þ¤Ë¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¤½¤Î¼Â¹Ô¤Î°ìÉô¤È¤·¤Æµ­½Ò¤µ¤ì¤Æ¤¤¤ë¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢
¤ª¤è¤Ó¥á¥ó¥Ð¤Î̾¾Î¤Ë¥¯¥í¥¹¥ê¥Õ¥¡¥ì¥ó¥¹¥ê¥ó¥¯¤ò¼«Æ°Åª¤Ë
Äɲä·¤Þ¤¹¡£¥ê¥ó¥¯¤Ï¡¢¼¡¤Î²Õ½ê¤Ë¸½¤ï¤ì¤Þ¤¹¡£
.LP
.TP 2
\(bu
Àë¸À (Ìá¤êÃͤη¿¡¢°ú¿ô¤Î·¿¡¢¥Õ¥£¡¼¥ë¥É¤Î·¿)
.TP 2
\(bu
@see ¥¿¥°¤«¤éÀ¸À®¤µ¤ì¤ë [´ØÏ¢¹àÌÜ] ¤Î¥»¥¯¥·¥ç¥ó
.TP 2
\(bu
{@link} ¥¿¥°¤«¤éÀ¸À®¤µ¤ì¤ë¥¤¥ó¥é¥¤¥ó¥Æ¥­¥¹¥È
.TP 2
\(bu
@throws ¥¿¥°¤«¤éÀ¸À®¤µ¤ì¤ëÎã³°¤Î̾¾Î
.TP 2
\(bu
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥á¥ó¥Ð¤ËÂФ¹¤ë [ÄêµÁ] ¥ê¥ó¥¯¤È¡¢¥¯¥é¥¹¤Î¥á¥ó¥Ð¤ËÂФ¹¤ë [¥ª¡¼¥Ð¡¼¥é¥¤¥É] ¥ê¥ó¥¯
.TP 2
\(bu
¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¤ª¤è¤Ó¥á¥ó¥Ð¤òµ­½Ò¤·¤¿°ìÍ÷ɽ
.TP 2
\(bu
¥Ñ¥Ã¥±¡¼¥¸¤È¥¯¥é¥¹¤Î·Ñ¾µ¥Ä¥ê¡¼
.TP 2
\(bu
º÷°ú
.LP
\-link ¤È \-linkoffline ¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Æ¡¢
¥³¥Þ¥ó¥É¹Ô¤Ë´Þ¤Þ¤ì¤Æ¤¤¤Ê¤¤¡¢¸ÄÊ̤ËÀ¸À®¤µ¤ì¤ë¥¯¥é¥¹¤Î´û¸¤Î¥Æ¥­¥¹¥È¤Ë
¥Ï¥¤¥Ñ¡¼¥ê¥ó¥¯¤òÄɲäǤ­¤Þ¤¹¡£
.LP
\f3¤½¤Î¾¤Î½èÍý¤Ë¤Ä¤¤¤Æ¤Î¾ÜºÙ\fP \-
javadoc ¥Ä¡¼¥ë¤Ï¡¢¼Â¹Ô¤Î¤¿¤Ó¤Ë¤Ò¤È¤Ä¤Î´°Á´¤Ê¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¤Þ¤¹¡£javadoc ¤Ï¡¢
ÄɲÃÀ¸À®¤ò¹Ô¤¨¤Þ¤»¤ó¡£¤Ä¤Þ¤ê¡¢°ÊÁ°¤Ë¼Â¹Ô¤·¤¿ javadoc ¤Î·ë²Ì¤òÊѹ¹¤·¤¿¤ê¡¢
¤½¤ì¤é¤òľÀܼè¤ê¹þ¤à¤³¤È¤Ï¤Ç¤­¤Þ¤»¤ó¡£¤·¤«¤·¡¢Á°½Ò¤Î¤è¤¦¤Ë¤Û¤«¤Î
¼Â¹Ô¤Î·ë²Ì¤Ë¥ê¥ó¥¯¤¹¤ë¤³¤È¤Ï²Äǽ¤Ç¤¹¡£
.LP
¼ÂÁõ¾å¤ÎÍýͳ¤«¤é¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¼Â¹Ô¤Ë java ¥³¥ó¥Ñ¥¤¥é¤òɬÍפȤ·¡¢java ¥³¥ó¥Ñ¥¤¥é¤Ë°Í¸¤·¤Æ¤¤¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï
.B javac
¤Î°ìÉô¤ò¸Æ¤Ó½Ð¤·¤Æ¡¢Àë¸À¤ò¥³¥ó¥Ñ¥¤¥ë¤·¡¢¥á¥ó¥Ð¤Î¼ÂÁõ¤Ï̵»ë¤·¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥¯¥é¥¹³¬Áؤò´Þ¤à¥¯¥é¥¹¤ÎË­ÉÙ¤ÊÆâÉôɽ¸½¡¢¤ª¤è¤Ó¡Ö»ÈÍѡ״ط¸¤ò
¹½ÃÛ¤·¡¢¤½¤³¤«¤é HTML ¤òÀ¸À®¤·¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥½¡¼¥¹¥³¡¼¥É¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤«¤é¡¢¥æ¡¼¥¶¤Î
Ä󶡤¹¤ë¥É¥­¥å¥á¥ó¥È¤â¼èÆÀ¤·¤Þ¤¹¡£
.LP
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥á¥½¥Ã¥ÉËÜÂΤΤʤ¤½ã¿è¤Ê¥¹¥¿¥Ö¥Õ¥¡¥¤¥ë¤Ç¤¢¤ë
.B .java
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¾å¤Ç¼Â¹Ô¤µ¤ì¤Þ¤¹¡£¤Ä¤Þ¤ê¡¢API ¤ÎºîÀ®»þ¤Ë¤Ï¡¢¥³¡¼¥É¤ò
µ­½Ò¤¹¤ëÁ°¤ÎÀ߷פÎÁᤤÃʳ¬¤Ç¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤òµ­½Ò¤·¡¢
.B javadoc
¤ò¼Â¹Ô¤Ç¤­¤Þ¤¹¡£
.LP
¥³¥ó¥Ñ¥¤¥é¤Ë°Í¸¤¹¤ë¤³¤È¤Ë¤è¤Ã¤Æ¡¢HTML ½ÐÎϤ¬¡¢¼ÂºÝ¤Î¼ÂÁõ¤ËÀµ³Î¤ËÂбþ
¤¹¤ë¤³¤È¤¬Êݾڤµ¤ì¤Þ¤¹¡£¼ÂºÝ¤Î¼ÂÁõ¤Ï¡¢ÌÀ¼¨Åª¤Ç¤Ê¤¯°ÅÌÛŪ¤Ë
¥½¡¼¥¹¥³¡¼¥É¤Ë°Í¸¤·¤Æ¤¤¤ë¾ì¹ç¤¬¤¢¤ê¤Þ¤¹¡£¤¿¤È¤¨¤Ð¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢
.B .class
¥Õ¥¡¥¤¥ëÆâ¤Ë¤Ï¸ºß¤¹¤ë¤¬¡¢¥½¡¼¥¹¥³¡¼¥ÉÆâ¤Ë¤Ï¸ºß¤·¤Ê¤¤
¥Ç¥Õ¥©¥ë¥È¥³¥ó¥¹¥È¥é¥¯¥¿ (¡ÖJava Language Specification¡×¤Î¥»¥¯¥·¥ç¥ó 8.6.7: http://java.sun.com/docs/books/jls/second_edition/html/names.doc.html#36154)
¤ò¥É¥­¥å¥á¥ó¥È²½¤·¤Þ¤¹¡£
.LP
¿¤¯¤Î¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ç¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¥³¡¼¥É¤¬ÉÔ´°Á´¤Þ¤¿¤Ï¥¨¥é¡¼¤ò
´Þ¤ó¤Ç¤¤¤ë¾ì¹ç¤Ç¤â¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤Ç¤­¤Þ¤¹¡£
¤³¤Î¤¿¤á¡¢¥Ç¥Ð¥Ã¥°¤ä¥È¥é¥Ö¥ë¥·¥å¡¼¥Æ¥£¥ó¥°¤¬´°Î»¤¹¤ëÁ°¤Ë
¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤Ç¤­¤Þ¤¹¡£ ¤¿¤È¤¨¤Ð¡¢Java ¸À¸ì»ÅÍͤˤè¤ë¤È¡¢
Ãê¾Ý¥á¥½¥Ã¥É¤ò´Þ¤à¥¯¥é¥¹¤Ï¤½¤ì¼«ÂΤòÃê¾Ý¤ÈÀë¸À¤·¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
¤³¤Î¥¨¥é¡¼¤ò¸¡½Ð¤¹¤ë¤È¡¢javac ¥³¥ó¥Ñ¥¤¥é¤Î¾ì¹ç¤Ï¡¢¤³¤Î¥¨¥é¡¼¤Ç
Ää»ß¤·¤Þ¤¹¤¬¡¢javadoc ¥Ä¡¼¥ë¤Ï·Ù¹ð¤ò½Ð¤µ¤º¤Ë½èÍý¤ò¿Ê¤á¤Þ¤¹¡£
javadoc ¥Ä¡¼¥ë¤Ï¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Î´ðËÜŪ¤Ê¥Á¥§¥Ã¥¯¤ò¹Ô¤¤¤Þ¤¹¡£
¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò¤è¤ê¾Ü¤·¤¯¥Á¥§¥Ã¥¯¤¹¤ëɬÍפ¬¤¢¤ë¾ì¹ç¤Ï¡¢
DocCheck ¥É¥Ã¥¯¥ì¥Ã¥È¤ò»ÈÍѤ·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.B javadoc
¥Ä¡¼¥ë¤¬¥É¥­¥å¥á¥ó¥ÈÍѤÎÆâÉô¹½Â¤¤ò¹½ÃÛ¤¹¤ë¤È¤­¤Ï¡¢»²¾È¤¹¤ë
¥¯¥é¥¹¤ò¤¹¤Ù¤Æ¥í¡¼¥É¤·¤Þ¤¹¡£¤³¤Î¤¿¤á¡¢¥Ö¡¼¥È¥¹¥È¥é¥Ã¥×¥¯¥é¥¹¡¢
³ÈÄ¥µ¡Ç½¡¢¤Þ¤¿¤Ï¥æ¡¼¥¶¥¯¥é¥¹¤Ë¤«¤«¤ï¤é¤º¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢»²¾È¤¹¤ë¥¯¥é¥¹¤ò¤¹¤Ù¤Æ¸¡½Ð¤Ç¤­¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
°ìÈÌŪ¤Ë¡¢ºîÀ®¤¹¤ë
¥¯¥é¥¹¤Ï¡¢³ÈÄ¥µ¡Ç½¤È¤·¤Æ¥í¡¼¥É¤µ¤ì¤ë¤«¡¢
.BR javadoc
¥Ä¡¼¥ë¤Î¥¯¥é¥¹¥Ñ¥¹Æâ¤Ë¤¢¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.SS "Javadoc ¥É¥Ã¥¯¥ì¥Ã¥È"
.B javadoc
¥Ä¡¼¥ë¤Î½ÐÎϤÎÆâÍƤȷÁ¼°¤Ï¡¢¥É¥Ã¥¯¥ì¥Ã¥È¤ò»È¤Ã¤Æ¥«¥¹¥¿¥Þ¥¤¥º¤Ç¤­¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ë¤Ï¡¢É¸½à¥É¥Ã¥¯¥ì¥Ã¥È¤È¸Æ¤Ð¤ì¤ë¥Ç¥Õ¥©¥ë¥È¤Î¡ÖÁȤ߹þ¤ß·¿¡×
¥É¥Ã¥¯¥ì¥Ã¥È¤¬¤¢¤ê¡¢¤³¤ì¤Ë¤è¤Ã¤Æ HTML ·Á¼°¤Î API
¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¤Þ¤¹¡£É¸½à¥É¥Ã¥¯¥ì¥Ã¥È
¤Î½¤Àµ¤ä¥µ¥Ö¥¯¥é¥¹²½¤ò¹Ô¤Ê¤Ã¤¿¤ê¡¢HTML¡¢XML¡¢MIF¡¢RTF ¤Ê¤É¤Î¹¥¤ß¤Î
½ÐÎÏ·Á¼°¤òÀ¸À®¤¹¤ëÆȼ«¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤òµ­½Ò¤¹¤ë¤³¤È¤â²Äǽ¤Ç¤¹¡£
¥É¥Ã¥¯¥ì¥Ã¥È¤È¤½¤Î»ÈÍÑË¡¤Ë¤Ä¤¤¤Æ¤Ï¡¢¼¡¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.TP 2
\(bu
.B Javadoc
¥É¥Ã¥¯¥ì¥Ã¥È
.TP 2
\(bu
.B -doclet
¥³¥Þ¥ó¥É¹Ô¥ª¥×¥·¥ç¥ó
.LP
.B -doclet
¥³¥Þ¥ó¥É¹Ô¥ª¥×¥·¥ç¥ó¤Ç¥«¥¹¥¿¥à¥É¥Ã¥¯¥ì¥Ã¥È¤¬»ØÄꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥Ç¥Õ¥©¥ë¥È¤Îɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤ò»ÈÍѤ·¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ë¤Ï¡¢¤É¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤¬»È¤ï¤ì¤Æ¤¤¤ë¤«¤Ë¤Ï´Ø·¸¤Ê¤¯»ÈÍѤǤ­¤ë
¥³¥Þ¥ó¥É¹Ô¥ª¥×¥·¥ç¥ó¤¬¤¢¤ê¤Þ¤¹¡£É¸½à¥É¥Ã¥¯¥ì¥Ã¥È¤Ç¤Ï¡¢¤³¤ì¤é¤Î
¤Û¤«¤Ë¡¢¤¤¤¯¤Ä¤«¤Î¥³¥Þ¥ó¥É¹Ô¥ª¥×¥·¥ç¥ó¤¬Äɲ䵤ì¤Þ¤¹¡£¤É¤Á¤é¤Î
¥ª¥×¥·¥ç¥ó¤Ë¤Ä¤¤¤Æ¤â¡¢¸å½Ò¤Î¡Ö¥ª¥×¥·¥ç¥ó¡×¤ÇÀâÌÀ¤·¤Þ¤¹¡£
.SS ´ØÏ¢¥É¥­¥å¥á¥ó¥È¤ª¤è¤Ó¥É¥Ã¥¯¥ì¥Ã¥È
.TP 2
\(bu
Javadoc ¤Ë»Ü¤µ¤ì¤¿µ¡Ç½¶¯²½ - Javadoc ¤ËÄɲ䵤줿²þÎÉÅÀ¤Î¾ÜºÙ
.TP 2
\(bu
Javadoc FAQ - ÉÑÈˤ˴󤻤é¤ì¤ë¼ÁÌä¤ËÂФ¹¤ë²óÅú¡¢Javadoc ´ØÏ¢¤Î¥Ä¡¼¥ë¤Ë¤Ä¤¤¤Æ¤Î¾ðÊ󡢤ª¤è¤Ó¥Ð¥°¤Î²óÈòÊýË¡
.TP 2
\(bu
Javadoc ¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¤òºîÀ®¤¹¤ë¤Ë¤Ï - Sun ¤Ç
°ìÈÌŪ¤Ê¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Îµ­½ÒÊýË¡¤Î¾ÜºÙ
.TP 2
\(bu
API »ÅÍͤòµ­½Ò¤¹¤ë¤¿¤á¤ÎÍ×·ï - Java 2 ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à»ÅÍͤòµ­½Ò¤¹¤ëºÝ¤Ë
»ÈÍѤµ¤ì¤¿É¸½àÍ×·ï¡£ ¤³¤Î¾ðÊó¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È
·Á¼°¤Ç API »ÅÍͤòµ­½Ò¤¹¤ë¾ì¹ç¤Ë¤â¡¢¤½¤Î¾¤Î·Á¼°¤Çµ­½Ò¤¹¤ë¾ì¹ç¤Ë¤â
ÌòΩ¤Á¤Þ¤¹¡£ ¸¡¾Ú²Äǽ¤Ê¥¢¥µ¡¼¥·¥ç¥ó¤òËþ¤¿¤¹¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥Õ¥£¡¼¥ë¥É¡¢¤ª¤è¤Ó¥á¥½¥Ã¥É¤Ë¤Ä¤¤¤Æ¤ÎÍ×·ï¤òÄê¤á¤Æ¤¤¤Þ¤¹¡£
.TP 2
\(bu
¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Î»ÅÍÍ - ¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Î
¥ª¥ê¥¸¥Ê¥ë»ÅÍͤˤĤ¤¤Æ¤Ï¡¢¡ØJava Language Specification¡Ù
(James Gosling¡¢Bill Joy¡¢Guy Steele ¶¦Ãø) ¤Î½éÈǤÎ
Âè 18 ¾Ï¡ÖDocumentation Comments¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
¤³¤Î¾Ï¤Ï¡¢Âè 2 ÈǤǤϺï½ü¤µ¤ì¤Þ¤·¤¿¡£
.TP 2
\(bu
DocCheck ¥É¥Ã¥¯¥ì¥Ã¥È - ¥½¡¼¥¹¥Õ¥¡¥¤¥ëÆâ¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò¸¡ºº¤·¡¢
¸«¤Ä¤«¤Ã¤¿¥¨¥é¡¼¤äÉÔµ¬Â§¤Ê²Õ½ê¤ò°ìÍ÷¤Ë¤·¤¿¥ì¥Ý¡¼¥È¤òÀ¸À®¤·¤Þ¤¹¡£
¤³¤ì¤Ï Sun Doc ¥Á¥§¥Ã¥¯¥æ¡¼¥Æ¥£¥ê¥Æ¥£¤Î°ìÉô¤Ç¤¹¡£
.TP 2
\(bu
MIF ¥É¥Ã¥¯¥ì¥Ã¥È - MIF¡¢FrameMaker¡¢¤ª¤è¤Ó PDF ·Á¼°¤Ç¤Î API ¥É¥­¥å¥á¥ó¥È¤Î
À¸À®¤ò¼«Æ°²½¤·¤Þ¤¹¡£ MIF ¤Ï Adobe FrameMaker ¤Î¸ß´¹·Á¼°¤Ç¤¹¡£
.SS "ÍѸì"
.LP
.LP
¡Ö\f2¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È\fP¡×¡¢¡Ö\f2doc ¥³¥á¥ó¥È\fP¡×¡¢¡Ö\f2¼çÀâÌÀ\fP¡×¡¢¡Ö\f2¥¿¥°\fP¡×¡¢¡Ö\f2¥Ö¥í¥Ã¥¯¥¿¥°\fP¡×¡¢¤ª¤è¤Ó¡Ö\f2¥¤¥ó¥é¥¤¥ó¥¿¥°\fP¡×¤ÎÍѸì¤Ë¤Ä¤¤¤Æ¤Ï¡¢¡Ö¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¡×¤ÇÀâÌÀ¤·¤Þ¤¹¡£°Ê²¼¤Î¤½¤Î¾¤ÎÍѸì¤Ï¡¢Javadoc ¥Ä¡¼¥ë¤Î¥³¥ó¥Æ¥­¥¹¥È¤ÇÆÃÄê¤Î°ÕÌ£¤ò»ý¤Á¤Þ¤¹¡£
.RS 3
.TP 3
À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È
.B javadoc
¥Ä¡¼¥ë¤¬ Java ¥½¡¼¥¹¥³¡¼¥ÉÆâ¤Î doc ¥³¥á¥ó¥È¤«¤éÀ¸À®¤·¤¿¥É¥­¥å¥á¥ó¥È
¤Î¤³¤È¤Ç¤¹¡£¥Ç¥Õ¥©¥ë¥È¤ÎÀ¸À®¥É¥­¥å¥á¥ó¥È¤Ï HTML ·Á¼°¤Ç¡¢É¸½à
¥É¥Ã¥¯¥ì¥Ã¥È¤Ë¤è¤Ã¤ÆºîÀ®¤µ¤ì¤Þ¤¹¡£
.LP
.TP 3
̾Á°
Java ¸À¸ì¤Ç¤Î̾Á°¡¢¤Ä¤Þ¤ê¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢
¥Õ¥£¡¼¥ë¥É¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¤Þ¤¿¤Ï¥á¥½¥Ã¥É¤Î̾Á°¤Î¤³¤È¤Ç¤¹¡£Ì¾Á°¤Ï¡¢
.BR java.lang.String.equals(java.lang.Object)
¤Î¤è¤¦¤Ë´°Á´½¤¾þ¤¹¤ë¤³¤È¤â¡¢
.BR equals(Object)
¤Î¤è¤¦¤ËÉôʬ½¤¾þ¤¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
.LP
.TP 3
¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹
.B javadoc
¤Î¼Â¹Ô¤Ë¤è¤Ã¤Æ´°Á´¤Ê¥É¥­¥å¥á¥ó¥È¤¬À¸À®¤µ¤ì¤ë¥¯¥é¥¹¤È
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ç¤¹¡£¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¤Ë¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤¬
»ÈÍѲÄǽ¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤º¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Î
¤É¤Á¤é¤«¤ò
.B javadoc
¥³¥Þ¥ó¥É¤ËÅϤµ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹¤Ï¡¢
.B javadoc
¤Î¼Â¹Ô¤ÇÁȤ߹þ¤Þ¤ì¤ë¥¯¥é¥¹¡¢¤Ä¤Þ¤ê¡ÖÁȤ߹þ¤ß¥¯¥é¥¹¡×¤È¤â¸Æ¤Ð¤ì¤Þ¤¹¡£
.LP
.TP 3
´Þ¤Þ¤ì¤ë¥¯¥é¥¹
Âбþ¤¹¤ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸Ì¾¤¬ javadoc ¥³¥Þ¥ó¥É¤Ë
ÅϤµ¤ì¤ë¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¤³¤È¤Ç¤¹¡£
.LP
.TP 3
½ü³°¤µ¤ì¤ë¥¯¥é¥¹
javadoc ¥³¥Þ¥ó¥É¤Ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸Ì¾¤¬
ÅϤµ¤ì¤Ê¤¤¥¯¥é¥¹¤È¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ç¤¹¡£
.LP
.TP 3
»²¾È¥¯¥é¥¹
¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹¤È¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ÎÄêµÁ
(¼ÂÁõ) ¤Þ¤¿¤Ï¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥ÈÆâ¤ÇÌÀ¼¨Åª¤Ë»²¾È¤µ¤ì¤ë
¥¯¥é¥¹¤È¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ç¤¹¡£»²¾È¤ÎÎã¤È¤·¤Æ¤Ï¡¢
Ìá¤êÃͤη¿¡¢¥Ñ¥é¥á¡¼¥¿¤Î·¿¡¢¥­¥ã¥¹¥È¤Î·¿¡¢
³ÈÄ¥¤µ¤ì¤ë¥¯¥é¥¹¡¢¼ÂÁõ¤µ¤ì¤ë¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢
¥¤¥ó¥Ý¡¼¥È¤µ¤ì¤ë¥¯¥é¥¹¡¢¥á¥½¥Ã¥ÉËÜÂΤǻÈÍѤµ¤ì¤ë
¥¯¥é¥¹¡¢@see¡¢{@link}¡¢{@linkplain}¡¢
¤ª¤è¤Ó {@inheritDoc} ¥¿¥°¤Ê¤É¤¬¤¢¤ê¤Þ¤¹
(¤³¤ÎÄêµÁ¤Ï 1.3
.fi
(http://java.sun.com/j2se/1.3/docs/tooldocs/solaris/javadoc.html#referencedclasses)
¤«¤é
Êѹ¹¤µ¤ì¤Æ¤¤¤ë¤³¤È¤ËÃí°Õ)¡£
javadoc ¥Ä¡¼¥ë¤ÏÆ°ºîÃæ¡¢
.B javadoc
¤Î¥Ö¡¼¥È¥¯¥é¥¹¥Ñ¥¹¤È
¥¯¥é¥¹¥Ñ¥¹Æâ¤Ë¤¢¤ë»²¾È¤µ¤ì¤Æ¤¤¤ë¥¯¥é¥¹¤ò
¤¹¤Ù¤Æ¥á¥â¥ê¤Ë¥í¡¼¥É¤¹¤ë¤¿¤á¤Ç¤¹¡£
»²¾È¤µ¤ì¤Æ¤¤¤ë¥¯¥é¥¹¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿
¾ì¹ç¤Ï¡¢[¥¯¥é¥¹¤¬¸«¤Ä¤«¤ê¤Þ¤»¤ó] ¤È¤¤¤¦·Ù¹ð¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥¯¥é¥¹¤Î¸ºß¤È¤½¤Î¥á¥ó¥Ð¤Î´°Á´½¤¾þ̾¤ò·èÄꤹ¤ë¤Î¤Ë½½Ê¬¤Ê¾ðÊó¤ò¡¢
.B .class
¥Õ¥¡¥¤¥ë¤«¤é°ú¤­½Ð¤¹¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
.TP 3
³°Éô»²¾È¥¯¥é¥¹
»²¾È¤µ¤ì¤ë¥¯¥é¥¹¤Î¤¦¤Á¡¢
.B javadoc
¤ò¼Â¹Ô¤·¤Æ¤â¥É¥­¥å¥á¥ó¥È¤¬À¸À®¤µ¤ì¤Ê¤¤¥¯¥é¥¹¤Ç¤¹¡£
¤Ä¤Þ¤ê¡¢¤³¤ì¤é¤Î¥¯¥é¥¹¤Ï¡¢¥³¥Þ¥ó¥É¹Ô¤Ç
.B javadoc
¥Ä¡¼¥ë¤ËÅϤµ¤ì¤Æ¤¤¤Þ¤»¤ó¡£
À¸À®¥É¥­¥å¥á¥ó¥ÈÆâ¤Ç¤³¤ì¤é¤Î¥¯¥é¥¹¤Ë¥ê¥ó¥¯¤·¤Æ¤¤¤ë²Õ½ê¤Ï¡¢
¡Ö³°Éô»²¾È¡×¤Þ¤¿¤Ï¡Ö³°Éô¥ê¥ó¥¯¡×¤È¸Æ¤Ð¤ì¤Þ¤¹¡£ ¤¿¤È¤¨¤Ð¡¢
.B java.awt
¥Ñ¥Ã¥±¡¼¥¸¤ËÂФ·¤Æ¤À¤±
.B javadoc
¤ò¼Â¹Ô¤·¤¿¾ì¹ç¡¢Object ¤Ê¤É¤Î
.BR java.lang
Æâ¤Î¤¹¤Ù¤Æ¤Î¥¯¥é¥¹¤Ï¡¢³°Éô»²¾È¥¯¥é¥¹¤Ë¤Ê¤ê¤Þ¤¹¡£³°Éô»²¾È¥¯¥é¥¹¤Ë¤Ï¡¢
.B \-link
¤ª¤è¤Ó
.B \-linkoffline
¥ª¥×¥·¥ç¥ó¤ò»È¤Ã¤Æ¥ê¥ó¥¯¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
³°Éô»²¾È¥¯¥é¥¹¤Ë¤Ï¡¢Ä̾綠¤Î¥½¡¼¥¹¥³¥á¥ó¥È¤ò
.B \javadoc
¥Ä¡¼¥ë¤Î¼Â¹Ô¤ÇÍøÍѤǤ­¤Ê¤¤¤È¤¤¤¦½ÅÍפÊÆÃħ¤¬¤¢¤ê¤Þ¤¹¡£
¤³¤Î¾ì¹ç¡¢¤½¤ì¤é¤Î¥³¥á¥ó¥È¤ò·Ñ¾µ¤¹¤ë¤³¤È¤Ï¤Ç¤­¤Þ¤»¤ó¡£
.SH "¥½¡¼¥¹¥Õ¥¡¥¤¥ë"
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥¯¥é¥¹¤Î Java ¸À¸ì¥½¡¼¥¹¥Õ¥¡¥¤¥ë (\f3.java\f1)¡¢¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¡¢
³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¡¢¤ª¤è¤Ó¤½¤Î¾¤Î½èÍý¤µ¤ì¤Ê¤¤¥Õ¥¡¥¤¥ë¤Î 4 ¼ïÎà¤Î
¡Ö¥½¡¼¥¹¡×¥Õ¥¡¥¤¥ë¤ò´ð¤Ë¤·¤Æ¡¢½ÐÎϤòÀ¸À®¤·¤Þ¤¹¡£¤Þ¤¿¡¢¥É¥­¥å¥á¥ó¥È²½¤·¤Ê¤¤¤¬¥½¡¼¥¹¥Ä¥ê¡¼¤Ë¸ºß¤¹¤ë¾ì¹ç¤¬¤¢¤ë¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤ä¥Æ¥ó¥×¥ì¡¼¥È¤Ë¤Ä¤¤¤Æ¤âÀâÌÀ¤·¤Þ¤¹¡£
.SS "¥¯¥é¥¹¥½¡¼¥¹¥³¡¼¥É¥Õ¥¡¥¤¥ë"
³Æ¥¯¥é¥¹¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¤ª¤è¤Ó¤½¤Î¥á¥ó¥Ð¤Ï¡¢
.B .java
¥Õ¥¡¥¤¥ë¤ÎÃæ¤Ë¤½¤ì¼«¿È¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò
»ý¤Ä¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Î¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
¡Ö¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¡×¤ÎÀá¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.SS "¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë"
³Æ¥Ñ¥Ã¥±¡¼¥¸¤Ï¡¢Æȼ«¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò
»ý¤Ä¤³¤È¤¬¤Ç¤­¡¢¡Ö¥½¡¼¥¹¡×¥Õ¥¡¥¤¥ë¤ËÊÝ»ý¤·¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢À¸À®¤¹¤ë¥Ñ¥Ã¥±¡¼¥¸¤ÎÍ×Ìó¥Ú¡¼¥¸¤Ë¤³¤Î¥³¥á¥ó¥È¤ò¥Þ¡¼¥¸¤·¤Þ¤¹¡£
Ä̾¤³¤Î¥³¥á¥ó¥È¤Ë¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸Á´ÂΤËŬÍѤµ¤ì¤ë
¥É¥­¥å¥á¥ó¥È¤ò´Þ¤á¤Þ¤¹¡£
.LP
¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤òºîÀ®¤¹¤ë¾ì¹ç¡¢¥³¥á¥ó¥È¤Î³ÊǼÀè¤È¤·¤Æ¡¢¼¡¤Î 2 ¤Ä¤Î¥Õ¥¡¥¤¥ë¤Î¤¤¤º¤ì¤«¤òÁªÂò¤Ç¤­¤Þ¤¹¡£
.LP
.RS 3
.TP 2
o
\f2package\-info.java\fP \- ¥Ñ¥Ã¥±¡¼¥¸Àë¸À¡¢¥Ñ¥Ã¥±¡¼¥¸Ãí¼á¡¢¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¡¢¤ª¤è¤Ó Javadoc ¥¿¥°¤ò³ÊǼ¤Ç¤­¤Þ¤¹¡£¤³¤Î¥Õ¥¡¥¤¥ë¤Ï JDK 5.0 ¤ÇƳÆþ¤µ¤ì¤¿¤â¤Î¤Ç¤¢¤ê¡¢package.html ¤è¤ê¤â¿ä¾©¤µ¤ì¤Æ¤¤¤Þ¤¹¡£
.TP 2
o
\f2package.html\fP \- ³ÊǼ¤Ç¤­¤ë¤Î¤Ï¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¤È Javadoc ¥¿¥°¤À¤±¤Ç¤¹¡£¥Ñ¥Ã¥±¡¼¥¸Ãí¼á¤Ï³ÊǼ¤Ç¤­¤Þ¤»¤ó¡£
.RE
.LP
.LP
³Æ¥Ñ¥Ã¥±¡¼¥¸¤Ï¡¢Ã±°ì¤Î \f2package.html\fP ¥Õ¥¡¥¤¥ë¡¢Ã±°ì¤Î \f2package\-info.java\fP ¥Õ¥¡¥¤¥ë¤Î¤¤¤º¤ì¤«¤ò»ý¤Ä¤³¤È¤¬¤Ç¤­¤Þ¤¹¤¬¡¢Î¾Êý¤ò»ý¤Ä¤³¤È¤Ï¤Ç¤­¤Þ¤»¤ó¡£¤³¤Î¤É¤Á¤é¤«¤Î¥Õ¥¡¥¤¥ë¤ò \f2.java\fP ¥Õ¥¡¥¤¥ë¤È¤È¤â¤Ë¡¢¥½¡¼¥¹¥Ä¥ê¡¼Æâ¤Î¤½¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥Ç¥£¥ì¥¯¥È¥êÆâ¤ËÇÛÃÖ¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.LP
\f4package\-info.java\fP ¤³¤Î¥Õ¥¡¥¤¥ë¤Ë¤Ï¡¢¼¡¤Î¹½Â¤¤Î¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¤ò³ÊǼ¤Ç¤­¤Þ¤¹¡£¥³¥á¥ó¥È¤Ï¥Ñ¥Ã¥±¡¼¥¸Àë¸À¤ÎÁ°¤ËÇÛÃÖ¤·¤Þ¤¹¡£
.LP
.LP
File: \f2java/applet/package\-info.java\fP
.LP
.ft 3
.nf
/**
* Provides the classes necessary to create an
* applet and the classes an applet uses
* to communicate with its applet context.
* <p>
* The applet framework involves two entities:
* the applet and the applet context.
* An applet is an embeddable window (see the
* {@link java.awt.Panel} class) with a few extra
* methods that the applet context can use to
* initialize, start, and stop the applet.
*
* @since 1.0
* @see java.awt
*/
package java.lang.applet;
.fi
.ft 1
.LP
¥³¥á¥ó¥È¶èÀÚ¤êʸ»ú¤Î \f2/**\fP ¤È \f2*/\fP ¤Ïµ­½Ò¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¤¬¡¢Ãæ´Ö¹Ô¤Î¹ÔƬ¤Î¥¢¥¹¥¿¥ê¥¹¥¯¤Ï¾Êά¤·¤Æ¤â¤«¤Þ¤¤¤Þ¤»¤ó¡£
.LP
.LP
\f4package.html\fP \- ¤³¤Î¥Õ¥¡¥¤¥ë¤Ë¤Ï¡¢¼¡¤Î¹½Â¤¤Î¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¤ò³ÊǼ¤Ç¤­¤Þ¤¹¡£¥³¥á¥ó¥È¤Ï \f2<body>\fP Í×ÁÇÆâ¤ËÇÛÃÖ¤·¤Þ¤¹¡£
.LP
.LP
File: \f2java/applet/package.html\fP
.LP
.LP
.ft 3
.nf
<HTML>
<BODY>
Provides the classes necessary to create an applet and the
classes an applet uses to communicate with its applet context.
<p>
The applet framework involves two entities: the applet
and the applet context. An applet is an embeddable
window (see the {@link java.awt.Panel} class) with a
few extra methods that the applet context can use to
initialize, start, and stop the applet.
@since 1.0
@see java.awt
</BODY>
</HTML>
.fi
.ft 1
.LP
.LP
¤³¤ì¤Ïñ¤Ê¤ëÄ̾ï¤Î HTML ¥Õ¥¡¥¤¥ë¤Ç¤¢¤ê¡¢¥Ñ¥Ã¥±¡¼¥¸Àë¸À¤ò´Þ¤ó¤Ç¤¤¤Ê¤¤ÅÀ¤ËÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤ÎÆâÍƤϡ¢¤Û¤«¤Î¤¹¤Ù¤Æ¤Î¥³¥á¥ó¥È¤ÈƱÍÍ¤Ë HTML ¤Çµ­½Ò¤µ¤ì¤Æ¤¤¤Þ¤¹¡£¤¿¤À¤·¡¢¤Û¤«¤Î¥³¥á¥ó¥È¤È°Û¤Ê¤ëÅÀ¤¬ 1 ¤Ä¤À¤±¤¢¤ê¤Þ¤¹¡£¤½¤ì¤Ï¡¢¤³¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ë¤Ï¡¢¥³¥á¥ó¥È¶èÀÚ¤êʸ»ú¤Ç¤¢¤ë \f2/**\fP ¤È \f2*/\fP¡¢¤ª¤è¤Ó¹ÔƬ¤Î¥¢¥¹¥¿¥ê¥¹¥¯¤ò´Þ¤á¤Æ¤Ï¤Ê¤é¤Ê¤¤¡¢¤È¤¤¤¦¤³¤È¤Ç¤¹¡£¥³¥á¥ó¥È¤ò½ñ¤¯¾ì¹ç¤Ï¡¢ºÇ½é¤Îʸ¤ò¥Ñ¥Ã¥±¡¼¥¸¤Î³µÍפȤ·¡¢\f2<body>\fP ¤ÈºÇ½é¤Îʸ¤Î´Ö¤Ë¥¿¥¤¥È¥ë¤ä¤½¤Î¾¤Î¥Æ¥­¥¹¥È¤ò´Þ¤á¤Ê¤¤¤è¤¦¤Ë¤·¤Þ¤¹¡£¥Ñ¥Ã¥±¡¼¥¸¥¿¥°¤ò´Þ¤á¤ë¤³¤È¤Ï¤Ç¤­¤Þ¤¹¤¬¡¢¤Û¤«¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ÈƱÍÍ¡¢Á´¤Æ¤Î¥Ö¥í¥Ã¥¯¥¿¥°¤ÏÀâÌÀ¤Î¤¢¤È¤ËÃÖ¤«¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤Ë \f2@see\fP ¥¿¥°¤òÄɲ乤ë¾ì¹ç¤Ï¡¢´°Á´»ØÄê¤Î̾Á°¤ò»ÈÍѤ¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£¾ÜºÙ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#packagecomments
¤Î
.na
¡Ö\f2example of \fP\f2package.html\fP¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.LP
\f3¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤Î½èÍý\fP \- Javadoc ¥Ä¡¼¥ë¤Ï¡¢¼Â¹Ô»þ¤Ë¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤ò¼«Æ°Åª¤Ë¸¡º÷¤·¡¢¤³¤Î¥Õ¥¡¥¤¥ë¤ò¸«¤Ä¤±¤ë¤È¼¡¤Î½èÍý¤ò¹Ô¤¤¤Þ¤¹¡£
.LP
.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
À¸À®¤·¤¿¥Ñ¥Ã¥±¡¼¥¸¤Î³µÍ×¥Ú¡¼¥¸¤ÎºÇ¸å¤Ë¡¢½èÍý¤·¤¿¥Æ¥­¥¹¥È¤òÁÞÆþ¤¹¤ë (Îã: ¥Ñ¥Ã¥±¡¼¥¸¤Î³µÍ×)
.TP 2
o
¥Ñ¥Ã¥±¡¼¥¸¤Î³µÍ×¥Ú¡¼¥¸¤ÎÀèƬ¤Ë¡¢¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¤ÎºÇ½é¤Îʸ¤ò¥³¥Ô¡¼¤¹¤ë¡£¤µ¤é¤Ë¡¢³µÍ×¥Ú¡¼¥¸¤Î¥Ñ¥Ã¥±¡¼¥¸¥ê¥¹¥È¤Ë¡¢¥Ñ¥Ã¥±¡¼¥¸Ì¾¤È¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¤ÎºÇ½é¤Îʸ¤òÄɲ乤ë (Îã: ³µÍפÎÍ×Ìó)¡£Ê¸¤ÎËöÈø¤Ï¡¢¥¯¥é¥¹¤ä¥á¥ó¥Ð¤Î¼çÀâÌÀ¤ÎºÇ½é¤Îʸ¤ÎËöÈø¤ÈƱ¤¸µ¬Â§¤Ë¤è¤Ã¤ÆȽÃǤµ¤ì¤ë
.RE
.LP
.SS "³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë"
¥É¥­¥å¥á¥ó¥È²½¤¹¤ë³Æ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸¤Î¥»¥Ã¥È¤Ï¡¢
Æȼ«¤Î³µÍץɥ­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò»ý¤Ä¤³¤È¤¬¤Ç¤­¡¢¤½¤ì¤Ï
¡Ö¥½¡¼¥¹¡×¥Õ¥¡¥¤¥ë¤ËÊÝ»ý¤µ¤ì¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢À¸À®¤¹¤ë³µÍ×¥Ú¡¼¥¸¤Ë¤³¤Î¥³¥á¥ó¥È¤ò¥Þ¡¼¥¸¤·¤Þ¤¹¡£Ä̾¤³¤Î
¥³¥á¥ó¥È¤Ë¤Ï¡¢¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸¤Î¥»¥Ã¥ÈÁ´ÂΤË
Åö¤Æ¤Ï¤Þ¤ë¥É¥­¥å¥á¥ó¥È¤ò´Þ¤á¤Þ¤¹¡£
.LP
³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤òºîÀ®¤¹¤ë¾ì¹ç¡¢¥Õ¥¡¥¤¥ë¤Ë¹¥¤­¤Ê̾Á°¤òÉÕ¤±¤Æ¡¢
¹¥¤­¤Ê¾ì½ê¤ËÃÖ¤¯¤³¤È¤¬¤Ç¤­¤Þ¤¹¤¬¡¢Ä̾ï¤Ï¥Õ¥¡¥¤¥ë̾¤ò
.B overview.html
¤Ë¤·¤Æ¡¢¥½¡¼¥¹¥Ä¥ê¡¼¤Î°ìÈÖ¾å¤Î³¬ÁؤËÃÖ¤­¤Þ¤¹¡£
¤¿¤È¤¨¤Ð¡¢
.B java.applet
¥Ñ¥Ã¥±¡¼¥¸¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤¬
.B /home/user/src/java/applet
¥Ç¥£¥ì¥¯¥È¥ê¤Ë´Þ¤Þ¤ì¤Æ¤¤¤ë¤È¤¹¤ë¤È¡¢
.BR /home/user/src/overview.html
¤Ë³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤òºîÀ®¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
°Û¤Ê¤ë¥Ñ¥Ã¥±¡¼¥¸¤Î¥»¥Ã¥È¤ËÂФ·¤Æ javadoc ¤òÊ£¿ô²ó¼Â¹Ô¤¹¤ë¾ì¹ç¤Ï¡¢Æ±¤¸ 1 ¤Ä¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¥»¥Ã¥È¤ËÂФ·¤ÆÊ£¿ô¤Î³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤òºîÀ®¤Ç¤­¤Þ¤¹¡£
¤¿¤È¤¨¤Ð¡¢ÆâÉô¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥óÍÑ¤Ë \-private ¤ò»ØÄꤷ¤Æ javadoc ¤ò 1 ²ó¼Â¹Ô¤·¤¿¤¢¤È¡¢¸ø³«¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥óÍѤˤ½¤Î¥ª¥×¥·¥ç¥ó¤ò»ØÄꤷ¤Ê¤¤¤ÇºÆÅټ¹Ԥ¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¤³¤Î¾ì¹ç¡¢³Æ³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤Î 1 ʸÌܤǡ¢¤½¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¤ò¸ø³«ÍѤޤ¿¤ÏÆâÉôÍѤȤ·¤Æµ­½Ò¤Ç¤­¤Þ¤¹¡£
.LP
³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤ÎÆâÍƤϡ¢Á°¤Ë½Ò¤Ù¤¿¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤È
ƱÍÍ¡¢HTML ¤Çµ­½Ò¤µ¤ì¤¿ 1 ¤Ä¤ÎÂ礭¤Ê¥É¥­¥å¥á¥ó¥È
¥³¥á¥ó¥È¤Ç¤¹¡£¾ÜºÙ¤Ï¡¢Á°½Ò¤ÎÀâÌÀ¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£·«¤êÊÖ¤·¤Ë
¤Ê¤ê¤Þ¤¹¤¬¡¢¤³¤Î¥³¥á¥ó¥È¤ò½ñ¤¯¾ì¹ç¤Ï¡¢ºÇ½é¤Îʸ¤ò¥¢¥×¥ê¥±¡¼¥·¥ç¥ó
¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸¤Î¥»¥Ã¥È¤ÎÍ×Ìó¤Ë¤·¡¢
.B <body>
¤ÈºÇ½é¤Îʸ¤Î´Ö¤Ë¥¿¥¤¥È¥ë¤Þ¤¿¤Ï¤½¤Î¾¤Î¥Æ¥­¥¹¥È¤ò´Þ¤á¤Æ¤Ï¤Ê¤ê¤Þ¤»¤ó¡£
³µÍ×¥¿¥°¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¤É¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ë
¤Ä¤¤¤Æ¤â¡¢{\f3@link\f1}
°Ê³°¤Î¥¿¥°¤Ï¡¢ÀâÌÀ¤Î¤¢¤È¤ËÃÖ¤¯É¬Íפ¬¤¢¤ê¤Þ¤¹¡£
.B @see
¥¿¥°¤òÄɲ乤ë¾ì¹ç¤Ï¡¢´°Á´»ØÄê¤Î̾Á°¤ò»ÈÍѤ¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.LP
.BR javadoc
¥Ä¡¼¥ë¤Î¼Â¹Ô»þ¤Ë¡¢
.B \-overview
¥ª¥×¥·¥ç¥ó¤ò»È¤Ã¤Æ³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë̾¤ò»ØÄꤷ¤Þ¤¹¡£¥Õ¥¡¥¤¥ë¤Ï¡¢
¥Ñ¥Ã¥±¡¼¥¸¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¤ÈƱ¤¸¤è¤¦¤Ë½èÍý¤µ¤ì¤Þ¤¹¡£
.TP 2
\(bu
.B <body>
¥¿¥°¤È
.B </body>
¥¿¥°¤È¤Î´Ö¤Ë¤¢¤ë¤¹¤Ù¤Æ¤ÎÆâÍƤò½èÍý¤Î¤¿¤á¤Ë¥³¥Ô¡¼¤¹¤ë
.TP 2
\(bu
¸ºß¤¹¤ë³µÍ×¥¿¥°¤ò½èÍý¤¹¤ë
.TP 2
\(bu
³µÍפÎÍ×Ìó¤Ê¤É¤Î Javadoc ¤¬À¸À®¤¹¤ë³µÍ×¥Ú¡¼¥¸¤ÎºÇ¸å¤Ë¡¢
½èÍý¤µ¤ì¤¿¥Æ¥­¥¹¥È¤òÁÞÆþ¤¹¤ë
.TP 2
\(bu
³µÍ×¥Ú¡¼¥¸¤ÎÀèƬ¤Ë¡¢³µÍ×¥³¥á¥ó¥È¤ÎºÇ½é¤Îʸ¤ò¥³¥Ô¡¼¤¹¤ë
.SS "¤½¤Î¾¤Î½èÍý¤µ¤ì¤Ê¤¤¥Õ¥¡¥¤¥ë"
¥½¡¼¥¹¤Ë¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤ÇÀ¸À®Àè¤Î¥Ç¥£¥ì¥¯¥È¥ê¤Ë¥³¥Ô¡¼¤¹¤ë¡¢¤½¤Î¾¤ÎǤ°Õ¤Î¥Õ¥¡¥¤¥ë¤ò
´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£°ìÈ̤ˡ¢¤³¤Î¤è¤¦¤Ê¥Õ¥¡¥¤¥ë¤Ë¤Ï¡¢
¥µ¥ó¥×¥ë¤Î¥°¥é¥Õ¥£¥Ã¥¯¥Õ¥¡¥¤¥ë¡¢Java ¥½¡¼¥¹
(\f3.java\f1) ¤ª¤è¤Ó¥¯¥é¥¹ (\f3.class\f1) ¥Õ¥¡¥¤¥ë¡¢ÆâÍƤ¬
Ä̾ï¤Î Java ¥½¡¼¥¹
¥Õ¥¡¥¤¥ë¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Î±Æ¶Á¤ò¼õ¤±¤Ê¤¤
ÆÈΩ¤·¤¿ HTML ¥Õ¥¡¥¤¥ë¤Ê¤É¤¬¤¢¤ê¤Þ¤¹¡£
.LP
½èÍý¤µ¤ì¤Ê¤¤¥Õ¥¡¥¤¥ë¤ò´Þ¤á¤ë¤Ë¤Ï¡¢¤½¤ì¤é¤Î¥Õ¥¡¥¤¥ë¤ò
.BR doc-files
¤È¤¤¤¦¥Ç¥£¥ì¥¯¥È¥ê¤ËÃÖ¤­¤Þ¤¹¡£¤³¤Î¥Ç¥£¥ì¥¯¥È¥ê¤Ï¡¢Ç¤°Õ¤Î¥Ñ¥Ã¥±¡¼¥¸
¥Ç¥£¥ì¥¯¥È¥ê¤Î²¼¤ËºîÀ®¤Ç¤­¤Þ¤¹¡£¥Ñ¥Ã¥±¡¼¥¸¤´¤È¤Ë¤³¤Î¤è¤¦¤Ê¥µ¥Ö
¥Ç¥£¥ì¥¯¥È¥ê¤ò 1 ¤Ä»ý¤Ä¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¤³¤Î¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤Ë¤Ï¡¢
¥¤¥á¡¼¥¸¡¢¥µ¥ó¥×¥ë¥³¡¼¥É¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¡¢
.B .class
¥Õ¥¡¥¤¥ë¡¢¥¢¥×¥ì¥Ã¥È¡¢¤ª¤è¤Ó HTML ¥Õ¥¡¥¤¥ë¤òÆþ¤ì¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
¤¿¤È¤¨¤Ð¡¢¥Ü¥¿¥ó¤Î²èÁü
.B button.gif
¤ò
.B java.awt.Button
¥¯¥é¥¹¥É¥­¥å¥á¥ó¥È¤Ë´Þ¤á¤¿¤¤¾ì¹ç¤Ï¡¢¤½¤Î¥Õ¥¡¥¤¥ë¤ò
.B /home/user/src/java/awt/doc-files/
¥Ç¥£¥ì¥¯¥È¥ê¤ËÃÖ¤­¤Þ¤¹¡£
.BR doc-files
¥Ç¥£¥ì¥¯¥È¥ê¤ò
.B /home/user/src/java/doc-files
¤ËÃÖ¤¯¤³¤È¤Ï¤Ç¤­¤Þ¤»¤ó¡£¤³¤ì¤Ï¡¢
.B java
¤Ï¥Ñ¥Ã¥±¡¼¥¸¤Ç¤Ï¤Ê¤¯¡¢¤½¤Î¥Ç¥£¥ì¥¯¥È¥ê¤½¤Î¤â¤Î¤Ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤¬
Æþ¤Ã¤Æ¤¤¤Ê¤¤¤«¤é¤Ç¤¹¡£
.LP
¤³¤ì¤é¤Î½èÍý¤µ¤ì¤Ê¤¤¥Õ¥¡¥¤¥ë¤Ø¤Î¥ê¥ó¥¯¤Ï
¤¹¤Ù¤ÆÌÀ¼¨Åª¤Ëµ­½Ò¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£¤³¤ì¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤¬¥Õ¥¡¥¤¥ë¤ò¸«¤º¤Ë¡¢Ã±¤Ë¥Ç¥£¥ì¥¯¥È¥ê¤È¤½¤ÎÆâÍÆʪ¤òÀ¸À®Àè¤Ë
¥³¥Ô¡¼¤¹¤ë¤À¤±¤À¤«¤é¤Ç¤¹¡£¤¿¤È¤¨¤Ð¡¢
.B Button.java
¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥ÈÆâ¤Î¥ê¥ó¥¯¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
.ft 3
.nf
/**
* This button looks like this:
* <img src="doc-files/Button.gif">
*/
.fi
.ft 1
.SH "¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤ª¤è¤Ó¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë"
°ìÉô¤Î³«È¯¼Ô¤«¤é¡¢¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤ª¤è¤Ó¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë¤ò
Âбþ¤¹¤ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¶á¤¯¤Î¥½¡¼¥¹¥Ä¥ê¡¼¤ËÊݸ¤·¤¿¤¤¤È¤¤¤¦Í×˾¤¬¤¢¤ê¤Þ¤·¤¿¡£
¤Ä¤Þ¤ê¡¢¤³¤ì¤é¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ÈƱ¤¸¥Ç¥£¥ì¥¯¥È¥ê¤Þ¤¿¤Ï¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤Ë
Êݸ¤·¤¿¤¤¤È¤¤¤¦¤³¤È¤Ç¤¹¡£
.LP
¸ÄÊ̤Υ½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤ÇÌÀ¼¨Åª¤ËÅϤ·¤Æ
.B Javadoc
¥Ä¡¼¥ë¤ò¼Â¹Ô¤¹¤ë¾ì¹ç¤Ï¡¢
¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤ª¤è¤Ó¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë¤ò°Õ¿ÞŪ¤Ë½ü³°¤·¤Æ¡¢
½èÍý¤µ¤ì¤Ê¤¤¤è¤¦¤Ë¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¤¿¤À¤·¡¢¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Þ¤¿¤Ï
¥ï¥¤¥ë¥É¥«¡¼¥É¤ÇÅϤ¹¾ì¹ç¤Ï¡¢°Ê²¼¤Î¥ë¡¼¥ë¤Ë½¾¤Ã¤Æ¡¢¤³¤ì¤é¤Î¥Æ¥¹¥È¥Õ¥¡¥¤¥ë
¤ª¤è¤Ó¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë¤¬
½èÍý¤µ¤ì¤Ê¤¤¤è¤¦¤Ë¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.LP
¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤È¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë¤Î°ã¤¤¤Ï¡¢
¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤Ï¡¢ÀµÅö¤Ç¥³¥ó¥Ñ¥¤¥ë²Äǽ¤Ê¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ç¤¢¤ë¤Î¤ËÂФ·¤Æ¡¢
¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë¤Ï¡¢¤½¤¦¤Ç¤Ï¤Ê¤¤¤È¤¤¤¦ÅÀ¤Ç¤¹¡£¤¿¤À¤·¡¢
¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë¤â¡Ö.java¡×¤Ç½ª¤ï¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.TP
¥Æ¥¹¥È¥Õ¥¡¥¤¥ë \-
³«È¯¼Ô¤Î¿¤¯¤Ï¡¢¤¢¤ë¥Ñ¥Ã¥±¡¼¥¸¤Î¥³¥ó¥Ñ¥¤¥ë²Äǽ¤Ç¼Â¹Ô²Äǽ¤Ê
¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤ò¤½¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ÈƱ¤¸
¥Ç¥£¥ì¥¯¥È¥ê¤ËÇÛÃÖ¤·¤¿¤¤¤È¹Í¤¨¤Æ¤¤¤Þ¤¹¡£
¤·¤«¤·¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤Ï¡¢Ì¾Á°¤Ê¤·¥Ñ¥Ã¥±¡¼¥¸¤Ê¤É¡¢
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¥Ñ¥Ã¥±¡¼¥¸¤È¤ÏÊ̤Υѥ屡¼¥¸¤Ë°¤µ¤»¤¿¤¤¤È¤â
¹Í¤¨¤Æ¤¤¤Þ¤¹ (¤½¤Î¤¿¤á¡¢¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤Ë¤Ï package ¥¹¥Æ¡¼¥È¥á¥ó¥È¤¬¤Ê¤¤¤«¡¢
¤Þ¤¿¤Ï¥½¡¼¥¹¤È¤ÏÊ̤Πpackage ¥¹¥Æ¡¼¥È¥á¥ó¥È¤¬¤¢¤ê¤Þ¤¹)¡£
¤³¤Î¤è¤¦¤Ê¾õ¶·¤Ç¤Ï¡¢¥³¥Þ¥ó¥É¹Ô¤Ç»ØÄꤵ¤ì¤Æ¤¤¤ë¥½¡¼¥¹¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò»ØÄꤷ¤Æ
¤½¤Î¥½¡¼¥¹¤¬¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤Æ¤¤¤ë¤È¤­¤Ë¡¢
¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤Ï·Ù¹ð¤Þ¤¿¤Ï¥¨¥é¡¼¤ò°ú¤­µ¯¤³¤·¤Þ¤¹¡£
¤½¤Î¤è¤¦¤Ê¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤Ï¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤ËÇÛÃÖ¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
¤¿¤È¤¨¤Ð¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤ò
.B com.package1
¤ËÄɲ乤ë¾ì¹ç¤Ï¡¢¤½¤ì¤é¤Î¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤ò¡¢¥Ï¥¤¥Õ¥ó¤¬´Þ¤Þ¤ì¤ë¤¿¤á
¥Ñ¥Ã¥±¡¼¥¸Ì¾¤È¤·¤Æ¤Ï̵¸ú¤Ë¤Ê¤ë
¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤ËÇÛÃÖ¤·¤Þ¤¹¡£
.LP
.RS 5
com/package1/test-files/
.RE
.LP
¤³¤¦¤¹¤ë¤È¡¢
.B Javadoc
¥Ä¡¼¥ë¤Ç¤Ï·Ù¹ð¤Ê¤·¤Ç
test ¥Ç¥£¥ì¥¯¥È¥ê¤ò¥¹¥­¥Ã¥×¤·¤Þ¤¹¡£
.LP
¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤Ë doc ¥³¥á¥ó¥È¤¬´Þ¤Þ¤ì¤ë¾ì¹ç¡¢
¼¡¤Î¤è¤¦¤Ë¥ï¥¤¥ë¥É¥«¡¼¥É¤ò´Þ¤ó¤À¥Æ¥¹¥È¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤ÇÅϤ·¤Æ
¥Æ¥¹¥È¥Õ¥¡¥¤¥ë¤Î¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤¹¤ë¤è¤¦¤Ë¡¢
.B Javadoc
¥Ä¡¼¥ë¤òÊ̸Ĥ˼¹ԤǤ­¤ë¤è¤¦¤ËÀßÄê¤Ç¤­¤Þ¤¹¡£
\f2com/package1/test\-files/*.java\fP.
.TP
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¥Æ¥ó¥×¥ì¡¼¥È\-
¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë¤Î̾Á°¤Ï¡Ö.java¡×¤Ç½ª¤ï¤ë¤³¤È¤â¤¢¤ê¤Þ¤¹¤¬¡¢
¥Æ¥ó¥×¥ì¡¼¥È¥Õ¥¡¥¤¥ë¤Ï¥³¥ó¥Ñ¥¤¥ë¤Ç¤­¤Þ¤»¤ó¡£
¥½¡¼¥¹¥Ç¥£¥ì¥¯¥È¥ê¤ËÊÝ»ý¤·¤¿¤¤¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î
¥Æ¥ó¥×¥ì¡¼¥È¤¬¤¢¤ë¾ì¹ç¤Ï¡¢
¤³¤Î¥Õ¥¡¥¤¥ë̾¤Ë¥Ï¥¤¥Õ¥ó (Buffer-Template.java ¤Ê¤É) ¤ä
¤½¤Î¾¤ÎÉÔÀµ¤Ê Java ʸ»ú¤ò»ÈÍѤ·¤Þ¤¹¡£
¤³¤¦¤¹¤ë¤³¤È¤Ç¡¢½èÍý¤µ¤ì¤Ê¤¤¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£
¤³¤ì¤Ï¡¢
.B Javadoc
¥Ä¡¼¥ë¤¬½èÍý¤¹¤ë¤Î¤Ï¡¢¡Ö.java¡×ÀÜÈø¼­¤ò½ü¤¤¤¿Ì¾Á°¤¬
Àµµ¬¤Î¥¯¥é¥¹Ì¾¤Ç¤¢¤ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤À¤±¤Ç¤¢¤ë¤¿¤á¤Ç¤¹ (¡Ö¼±Ê̻ҡ×http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#40625 »²¾È)¡£
.SS "À¸À®¤µ¤ì¤ë¥Õ¥¡¥¤¥ë"
¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¡¢
.B javadoc
¤Ï¡¢HTML ·Á¼°¤Î¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤¹¤ëɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤ò
»È¤¤¤Þ¤¹¡£
¤³¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤Ï¡¢°Ê²¼¤Î¼ïÎà¤Î¥Õ¥¡¥¤¥ë¤òÀ¸À®¤·¤Þ¤¹¡£°Ê²¼¤Î
³Æ HTML¡Ö¥Ú¡¼¥¸¡×¤Ï¡¢¤½¤ì¤¾¤ìÊ̤Υե¡¥¤¥ë¤ËÂбþ¤·¤Þ¤¹¡£
.B javadoc
¤¬À¸À®¤¹¤ë¥Õ¥¡¥¤¥ë¤Î̾Á°¤Ë¤Ï¡¢¥¯¥é¥¹¤ä¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î̾Á°¤Ë
¤Á¤Ê¤ó¤À¤â¤Î¤È¡¢¤½¤¦¤Ç¤Ê¤¤¤â¤Î (\f3package-summary.html\f1 ¤Ê¤É)
¤Î 2 ¼ïÎब¤¢¤ê¤Þ¤¹¡£¸å¼Ô¤Î¥°¥ë¡¼¥×¤Ë¤Ï¡¢Á°¼Ô¤Î¥°¥ë¡¼¥×¤Î̾Á°¤È
¥Õ¥¡¥¤¥ë̾¤¬¶¥¹ç¤·¤Ê¤¤¤è¤¦¤Ë¡¢¥Ï¥¤¥Õ¥ó¤¬´Þ¤Þ¤ì¤Æ¤¤¤Þ¤¹¡£
.SS "´ðËÜÆâÍÆ¥Ú¡¼¥¸"
.TP 2
\(bu
¥É¥­¥å¥á¥ó¥È²½¤¹¤ë³Æ¥¯¥é¥¹¤Þ¤¿¤Ï³Æ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ËÂФ·¡¢1 ¤Ä¤Î¥¯¥é¥¹
¥Ú¡¼¥¸¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹¥Ú¡¼¥¸ (\f3classname.html\f1)
.TP 2
\(bu
¥É¥­¥å¥á¥ó¥È²½¤¹¤ë³Æ¥Ñ¥Ã¥±¡¼¥¸¤ËÂФ·¡¢1 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸
¥Ú¡¼¥¸ (\f3package-summary.html\f1)¡£
.B javadoc
¥Ä¡¼¥ë¤Ë¤è¤Ã¤Æ¡¢¥½¡¼¥¹¥Ä¥ê¡¼¤Î¥Ñ¥Ã¥±¡¼¥¸¥Ç¥£¥ì¥¯¥È¥êÆâ¤Î
.B package.html
¤Þ¤¿¤Ï
package\-info.java
¤È¤¤¤¦¥Õ¥¡¥¤¥ëÆâ¤Î¤¹¤Ù¤Æ¤Î HTML ¥Æ¥­¥¹¥È¤¬´Þ¤á¤é¤ì¤ë
.TP 2
\(bu
¥Ñ¥Ã¥±¡¼¥¸¤Î¥»¥Ã¥ÈÁ´ÂΤËÂФ·¤Æ 1 ¤Ä¤Î³µÍ×
¥Ú¡¼¥¸ (\f3overview-summary.html\f1)¡£¤³¤ì¤Ï¡¢À¸À®¤µ¤ì¤ë
¥É¥­¥å¥á¥ó¥È¤ÎÀèƬ¥Ú¡¼¥¸¤Ë¤Ê¤ë¡£
.B javadoc
¥Ä¡¼¥ë¤Ë¤è¤Ã¤Æ¡¢
.B -overview
¥ª¥×¥·¥ç¥ó¤Ç»ØÄꤵ¤ì¤¿¥Õ¥¡¥¤¥ëÆâ¤Î¤¹¤Ù¤Æ¤Î HTML ¥Æ¥­¥¹¥È¤¬´Þ¤á¤é¤ì¤ë¡£
¤³¤Î¥Õ¥¡¥¤¥ë¤¬ºîÀ®¤µ¤ì¤ë¤Î¤Ï¡¢
.B javadoc
¤Ë 2 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤òÅϤ·¤¿
¾ì¹ç¤À¤±¤Ç¤¢¤ë¤³¤È¤ËÃí°Õ¤¹¤ë¡£¾ÜºÙ¤Ï¡¢°Ê²¼¤Î¡ÖHTML ¥Õ¥ì¡¼¥à¡×Àá¤ò»²¾È
.SS "Áê¸ß»²¾È¥Ú¡¼¥¸"
.TP 2
\(bu
¥Ñ¥Ã¥±¡¼¥¸¤Î¥»¥Ã¥ÈÁ´ÂΤËÂФ·¤Æ 1 ¤Ä¤Î¥¯¥é¥¹³¬ÁØ¥Ú¡¼¥¸
(\f3overview-tree.html\f1)¡£¤³¤ì¤òɽ¼¨¤¹¤ë¤Ë¤Ï¡¢¥Ê¥Ó¥²¡¼¥·¥ç¥ó
¥Ð¡¼¤Î [³µÍ×] ¤ò¥¯¥ê¥Ã¥¯¤·¤Æ¤«¤é¡¢[³¬Áإĥ꡼] ¤ò¥¯¥ê¥Ã¥¯¤¹¤ë
.TP 2
\(bu
³Æ¥Ñ¥Ã¥±¡¼¥¸¤ËÂФ·¤Æ 1 ¤Ä¤Î¥¯¥é¥¹³¬ÁØ
¥Ú¡¼¥¸ (\f3package-tree.html\f1)¡£
ÆÃÄê¤Î¥Ñ¥Ã¥±¡¼¥¸¥Ú¡¼¥¸¡¢¥¯¥é¥¹¥Ú¡¼¥¸¡¢¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹¥Ú¡¼¥¸¤ò
ɽ¼¨¤·¡¢[³¬Áإĥ꡼] ¤ò¥¯¥ê¥Ã¥¯¤¹¤ë¤È¡¢¤½¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î³¬Áؤ¬
ɽ¼¨¤µ¤ì¤ë
.TP 2
\(bu
³Æ¥Ñ¥Ã¥±¡¼¥¸¤ËÂФ·¤Æ 1 ¤Ä¤Î [»ÈÍÑ]
¥Ú¡¼¥¸ (\f3package-use.html\f1)¤È¡¢
³Æ¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ËÂФ·¤ÆÊÌ¤Ë 1 ¤Ä¤Î [»ÈÍÑ]
¥Ú¡¼¥¸(\f3class-use/classname.html\f1)¡£¤³¤Î¥Ú¡¼¥¸¤Ï¡¢ÆÃÄê¤Î¥¯¥é¥¹¡¢
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸¤Î¤Ê¤ó¤é¤«¤ÎÉôʬ¤ò»È¤Ã¤Æ¤¤¤ë
¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¥á¥½¥Ã¥É¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¤ª¤è¤Ó¥Õ¥£¡¼¥ë¥É¤ò
µ­½Ò¤¹¤ë¡£¥¯¥é¥¹¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹ A ¤Ë¤Ä¤¤¤Æ¹Í¤¨¤ë¤È¡¢
¤½¤Î[»ÈÍÑ] ¥Ú¡¼¥¸¤Ë¤Ï¡¢A ¤Î¥µ¥Ö¥¯¥é¥¹¡¢A ¤È¤·¤ÆÀë¸À¤µ¤ì¤¿
¥Õ¥£¡¼¥ë¥É¡¢A ¤òÊÖ¤¹¥á¥½¥Ã¥É¡¢A ·¿¤Î¥Ñ¥é¥á¡¼¥¿¤ò»ý¤Ä¥á¥½¥Ã¥É
¤ª¤è¤Ó¥³¥ó¥¹¥È¥é¥¯¥¿¤¬É½¼¨¤µ¤ì¤ë¡£¤³¤Î¥Ú¡¼¥¸¤Ë¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸¡¢
¥¯¥é¥¹¡¢¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ë°ÜÆ°¤·¤Æ¤«¤é¡¢¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼
¤Î [»ÈÍÑ] ¥ê¥ó¥¯¤ò¥¯¥ê¥Ã¥¯¤¹¤ë¤³¤È¤Ë¤è¤Ã¤Æ¥¢¥¯¥»¥¹¤Ç¤­¤ë
.TP 2
\(bu
Èó¿ä¾© API ¥Ú¡¼¥¸ (\f3deprecated-list.html\f1)¡£¿ä¾©¤µ¤ì¤Ê¤¤
̾Á°¤¹¤Ù¤Æ¤Î°ìÍ÷¤¬´Þ¤Þ¤ì¤Æ¤¤¤ë (Èó¿ä¾©Ì¾¤Ï¡¢Ä̾ï¤Ï²þÎɤµ¤ì¤¿ API ¤¬
¸ºß¤¹¤ë¤¿¤á¤Ë»ÈÍѤ¬¿ä¾©¤µ¤ì¤Æ¤¤¤Ê¤¤ API ¤Î̾Á°¤Ç¡¢¤¿¤¤¤Æ¤¤¤Ï¤½¤ì¤Ë
ÃÖ¤­´¹¤ï¤ë̾Á°¤¬Ä󼨤µ¤ì¤Æ¤¤¤ë¡£Èó¿ä¾© API ¤Ï¡¢¾­Íè¤Î¼ÂÁõ¤Ç¤Ï
ºï½ü¤µ¤ì¤ë²ÄǽÀ­¤¬¤¢¤ë)
.TP 2
\(bu
Äê¿ô¥Õ¥£¡¼¥ë¥ÉÃÍ¥Ú¡¼¥¸ (\f3constant-values.html\f1) ¡£
static ¥Õ¥£¡¼¥ë¥É¤ÎÃͤ¬É½¼¨¤µ¤ì¤ë¡£
.TP 2
\(bu
ľÎó²½·Á¼°¥Ú¡¼¥¸ (\f3serialized-form.html\f1)¡£Ä¾Îó²½²Äǽ¥¯¥é¥¹
¤ª¤è¤Ó³°Éô²½²Äǽ¥¯¥é¥¹¤Î¾ðÊóÍÑ¡£¤³¤ì¤é¤Î³Æ¥¯¥é¥¹¤Ë¤Ï¡¢Ä¾Îó²½
¥Õ¥£¡¼¥ë¥É¤ª¤è¤Ó¥á¥½¥Ã¥É¤Ë´Ø¤¹¤ëÀâÌÀ¤¬¤¢¤ë¡£¤³¤ì¤é¤Î¾ðÊó¤Ï¡¢API ¤ò
»È¤¦³«È¯¼Ô¤Ç¤Ï¤Ê¤¯¡¢ºÆ¼ÂÁõ¼Ô¤ËɬÍפʾðÊó¤Ç¤¢¤ë¡£¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Ë
¥ê¥ó¥¯¤¬¤Ê¤¤¾ì¹ç¡¢Ç¤°Õ¤ÎľÎ󲽤µ¤ì¤¿¥¯¥é¥¹¤Ë°ÜÆ°¤·¤Æ¡¢
¥¯¥é¥¹¤Î [´ØÏ¢¹àÌÜ] ¥»¥¯¥·¥ç¥óÆâ¤Î [ľÎ󲽤µ¤ì¤¿·Á¼°] ¤ò¥¯¥ê¥Ã¥¯
¤¹¤ë¤È¤³¤Î¾ðÊó¤ò¼èÆÀ¤Ç¤­¤ë
ɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤Ï¡¢Ä¾Î󲽤µ¤ì¤¿·Á¼°¤Î¥Ú¡¼¥¸¤ò¼«Æ°Åª¤ËÀ¸À®¤¹¤ë¡£
¤³¤³¤Ë¤Ï¡¢Serializable ¤ò¼ÂÁõ¤¹¤ë public ¤Þ¤¿¤ÏÈó public ¤Î
¥¯¥é¥¹¤¬ÁȤ߹þ¤Þ¤ì¤Æ¤ª¤ê¡¢¤µ¤é¤Ë¡¢
.B readObject
¥á¥½¥Ã¥É¡¢
.B writeObject
¥á¥½¥Ã¥É¡¢Ä¾Î󲽤µ¤ì¤¿¥Õ¥£¡¼¥ë¥É¡¢
¤ª¤è¤Ó @serial ¥¿¥°¡¢@serialField ¥¿¥°¡¢@serialData ¥¿¥°¤«¤é¤Î
¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤¬ÁȤ߹þ¤Þ¤ì¤Æ¤¤¤ë¡£
ľÎ󲽤¬²Äǽ¤Ê public ¥¯¥é¥¹¤ò½ü³°¤¹¤ë¤Ë¤Ï¡¢
¤½¤Î¥¯¥é¥¹¤Þ¤¿¤Ï¤½¤Î¥¯¥é¥¹¤¬Â°¤¹¤ë¥Ñ¥Ã¥±¡¼¥¸¤ò @serial exclude ¥¿¥°¤Ç
»ØÄꤹ¤ë¡£Ä¾Î󲽤¬²Äǽ¤Ê package private ¥¯¥é¥¹¤ò´Þ¤á¤ë¤Ë¤Ï¡¢
¤½¤Î¥¯¥é¥¹¤Þ¤¿¤Ï¤½¤Î¥¯¥é¥¹¤¬Â°¤¹¤ë¥Ñ¥Ã¥±¡¼¥¸¤ò @serial include ¥¿¥°¤Ç
»ØÄꤹ¤ë¡£ 1.4 ¤Ç¤Ï¡¢
\-private
¥ª¥×¥·¥ç¥ó¤ò»ØÄꤻ¤º¤Ë javadoc ¤ò¼Â¹Ô¤¹¤ë¤³¤È¤Ç¡¢public ¥¯¥é¥¹¤ª¤è¤Ó
private ¥¯¥é¥¹¤Ë´°Á´¤ÊľÎó²½·Á¼°¤òÀ¸À®¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¡£
.TP 2
\(bu
º÷°ú (\f3index-*.html\f1)¡£¤¹¤Ù¤Æ¤Î¥¯¥é¥¹Ì¾¡¢
¥¤¥ó¥¿¥Õ¥§¡¼¥¹Ì¾¡¢¥³¥ó¥¹¥È¥é¥¯¥¿Ì¾¡¢¥Õ¥£¡¼¥ë¥É̾¡¢¤ª¤è¤Ó¥á¥½¥Ã¥É̾¤ò
¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È½ç¤Ëʤ٤Ƥ¢¤ë¡£º÷°ú¤Ï¡¢Unicode ¤ò°·¤¨¤ë¤è¤¦¤Ë
¹ñºÝ²½¤µ¤ì¤Æ¤ª¤ê¡¢1 ¤Ä¤Î¥Õ¥¡¥¤¥ë¤È¤·¤ÆÀ¸À®¤¹¤ë¤«¡¢¤Þ¤¿¤ÏÀèƬ
ʸ»ú (±Ñ¸ì¤Î¾ì¹ç A ¤«¤é Z) ¤´¤È¤ËÊ̤Υե¡¥¤¥ë¤È¤·¤ÆÀ¸À®¤Ç¤­¤ë
.SS "¥µ¥Ý¡¼¥È¥Õ¥¡¥¤¥ë"
.TP 2
\(bu
¥Ø¥ë¥×¥Ú¡¼¥¸ (\f3help-doc.html\f1)¡£¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤ª¤è¤Ó
¾åµ­¤Î¥Ú¡¼¥¸¤Ë¤Ä¤¤¤ÆÀâÌÀ¤¹¤ë¡£
.BR \-helpfile
¤ò»È¤Ã¤Æ¡¢¥Ç¥Õ¥©¥ë¥È¤Î
¥Ø¥ë¥×¥Õ¥¡¥¤¥ë¤ËÃÖ¤­´¹¤ï¤ëÆȼ«¤Î¥«¥¹¥¿¥à¥Ø¥ë¥×¥Õ¥¡¥¤¥ë¤òÄ󶡤¹¤ë
¤³¤È¤â¤Ç¤­¤ë
.TP 2
\(bu
1 ¤Ä¤Î
.B index.html
¥Õ¥¡¥¤¥ë¡£É½¼¨ÍÑ ¤Î HTML ¥Õ¥ì¡¼¥à¤òºîÀ®¤¹¤ë¡£¤³¤Î¥Õ¥¡¥¤¥ë¤Ï¡¢
¥Õ¥ì¡¼¥àÉÕ¤­¤ÎºÇ½é¤Î¥Ú¡¼¥¸¤òɽ¼¨¤¹¤ë¾ì¹ç¤Ë¥í¡¼¥É¤¹¤ë¡£¤³¤Î¥Õ¥¡¥¤¥ë
¼«ÂΤϡ¢¥Æ¥­¥¹¥ÈÆâÍƤò´Þ¤Þ¤Ê¤¤
.TP 2
\(bu
Ê£¿ô¤Î¥Õ¥ì¡¼¥à¥Õ¥¡¥¤¥ë (\f3*-frame.html\f1)¡£¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢
¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î°ìÍ÷¤ò´Þ¤à¡£HTML ¥Õ¥ì¡¼¥à¤òɽ¼¨¤¹¤ë¤È¤­¤Ë
»È¤ï¤ì¤ë
.TP 2
\(bu
¥Ñ¥Ã¥±¡¼¥¸¥ê¥¹¥È¥Õ¥¡¥¤¥ë (\f3package-list\f1)¡£
.B \-link
¥ª¥×¥·¥ç¥ó¤ª¤è¤Ó
.B \-linkoffline
¥ª¥×¥·¥ç¥ó¤Ç»È¤ï¤ì¤ë¡£¤³¤ì¤Ï¡¢HTML ¥Õ¥¡¥¤¥ë¤Ç¤Ï¤Ê¤¯¥Æ¥­¥¹¥È¥Õ¥¡¥¤¥ë
¤Î¤¿¤á¡¢¥ê¥ó¥¯¤Ç¤Ï¥¢¥¯¥»¥¹¤Ç¤­¤Ê¤¤
.TP 2
\(bu
¥¹¥¿¥¤¥ë¥·¡¼¥È¥Õ¥¡¥¤¥ë (\f3stylesheet.css\f1)¡£À¸À®¤µ¤ì¤ë¥Ú¡¼¥¸¾å¤Ë
ɽ¼¨¤µ¤ì¤ë¸Â¤é¤ì¤¿¿§¿ô¡¢¥Õ¥©¥ó¥È¥Õ¥¡¥ß¥ê¡¢¥Õ¥©¥ó¥È¥µ¥¤¥º¡¢¥Õ¥©¥ó¥È¤Î
¥¹¥¿¥¤¥ë¤ª¤è¤ÓÇÛÃÖ¤òÀ©¸æ¤¹¤ë
.TP 2
\(bu
¥³¥Ô¡¼Àè¥Ç¥£¥ì¥¯¥È¥ê¤Ë¥³¥Ô¡¼¤·¤¿¤¤¥Õ¥¡¥¤¥ë (¥¤¥á¡¼¥¸¡¢¥µ¥ó¥×¥ë¡¢
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ê¤É) ¤¬Æþ¤Ã¤Æ¤¤¤ë doc ¥Õ¥¡¥¤¥ë¤Î¥Ç¥£¥ì¥¯¥È¥ê¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¤³¤Î¤è¤¦¤Ê¥Õ¥¡¥¤¥ë¤ò½èÍý¤·¤Ê¤¤¡£¤Ä¤Þ¤ê¡¢¤³¤Î¤è¤¦¤Ê¥Õ¥¡¥¤¥ëÆâ¤Î
.B javadoc
¥¿¥°¤Ï¤¹¤Ù¤Æ̵»ë¤µ¤ì¤ë¡£¥½¡¼¥¹¥Ä¥ê¡¼¤Ë¸ºß¤·¤Ê¤¤¸Â¤ê¡¢¤³¤Î
¥Ç¥£¥ì¥¯¥È¥ê¤ÏÀ¸À®¤µ¤ì¤Ê¤¤
.SS "HTML ¥Õ¥ì¡¼¥à"
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢²¼¤Î¿Þ¤Ë¼¨¤¹¤è¤¦¤Ë¡¢2 ¤Ä¤« 3 ¤Ä¤Î HTML ¥Õ¥ì¡¼¥à¤òÀ¸À®¤·¤Þ¤¹¡£
1 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸¤·¤«¤Ê¤¤¾ì¹ç (¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸¤¬¤Ê¤¤¾ì¹ç) ¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸¤Î°ìÍ÷¤ò¾Êά¤¹¤ë¤³¤È¤Ë¤è¤Ã¤ÆºÇÄã¸ÂɬÍפʿô¤Î¥Õ¥ì¡¼¥à¤òºîÀ®¤·¤Þ¤¹¡£
¥½¡¼¥¹¥Õ¥¡¥¤¥ë (*\f3.java\f1) ¤Þ¤¿¤Ïñ°ì¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò°ú¿ô¤È¤·¤Æ
.B javadoc
¥³¥Þ¥ó¥É¤ËÅϤ¹¾ì¹ç¤Ï¡¢º¸Â¦¤ÎÎó¤Ë¥¯¥é¥¹¤Î°ìÍ÷¤òɽ¼¨¤¹¤ë
¥Õ¥ì¡¼¥à (C) 1 ¤Ä¤À¤±¤¬ºîÀ®¤µ¤ì¤Þ¤¹¡£
.B javadoc
¤ËÊ£¿ô¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤òÅϤ¹¾ì¹ç¤Ï¡¢³µÍ×¥Ú¡¼¥¸ (Detail) ¤Ë²Ã¤¨¤Æ¡¢
¤¹¤Ù¤Æ¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î°ìÍ÷¤òɽ¼¨¤¹¤ëÂè 3 ¤Î¥Õ¥ì¡¼¥à (P) ¤¬
ºîÀ®¤µ¤ì¤Þ¤¹¡£¤³¤Î³µÍ×¥Ú¡¼¥¸¤Î¥Õ¥¡¥¤¥ë̾¤Ï
.BR overview-summary.html
¤Ç¤¹¡£¤·¤¿¤¬¤Ã¤Æ¡¢¤³¤Î¥Õ¥¡¥¤¥ë¤¬ºîÀ®¤µ¤ì¤ë¤Î¤Ï¡¢2 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸
̾¤òÅϤ·¤¿¾ì¹ç¤À¤±¤Ç¤¹¡£[¥Õ¥ì¡¼¥à¤Ê¤·] ¥ê¥ó¥¯¤ò¥¯¥ê¥Ã¥¯¤¹¤ë¤«¡¢
.BR overview-summary.html
¤«¤éɽ¼¨¤¹¤ë¤è¤¦¤Ë¤¹¤ë¤È¡¢¥Õ¥ì¡¼¥à¤ò¾Êά¤Ç¤­¤Þ¤¹¡£
.LP
HTML ¥Õ¥ì¡¼¥à¤Ë´·¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¤Ï¡¢¥Õ¥ì¡¼¥à¤Ë¤Ï¡¢°õºþ¤ª¤è¤Ó
¥¹¥¯¥í¡¼¥ëÍѤΡ֥ե©¡¼¥«¥¹¡×¤¬É¬ÍפǤ¢¤ë¤³¤È¤ËÃí°Õ¤¹¤ë
ɬÍפ¬¤¢¤ê¤Þ¤¹¡£¥Õ¥ì¡¼¥à¤Ë¥Õ¥©¡¼¥«¥¹¤òÍ¿¤¨¤ë¤Ë¤Ï¡¢¤½¤Î¥Õ¥ì¡¼¥à¤ò
¥¯¥ê¥Ã¥¯¤·¤Þ¤¹¡£¤¹¤ë¤È¡¢Â¿¤¯¤Î¥Ö¥é¥¦¥¶¤Ç¤Ï¡¢Ìð°õ¥­¡¼¤ª¤è¤Ó¥Ú¡¼¥¸¥­¡¼
¤ò»È¤Ã¤Æ¤½¤Î¥Õ¥ì¡¼¥à¤ò¥¹¥¯¥í¡¼¥ë¤·¤¿¤ê¡¢[°õºþ] ¥á¥Ë¥å¡¼
¥³¥Þ¥ó¥É¤ò»È¤Ã¤Æ¤½¤Î¥Õ¥ì¡¼¥à¤ò°õºþ¤·¤¿¤ê¤Ç¤­¤ë¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
.ft 3
.nf
------------ ------------
|C| Detail | |P| Detail |
| | | | | |
| | | |-| |
| | | |C| |
| | | | | |
| | | | | |
------------ ------------
javadoc *.java javadoc java.lang java.awt
.fi
.ft 1
.LP
HTML ¥Õ¥ì¡¼¥à¤¬É¬Íפ«¤É¤¦¤«¤Ë¤è¤Ã¤Æ¡¢¼¡¤Î¤É¤Á¤é¤«¤Î¥Õ¥¡¥¤¥ë¤ò
³«»Ï¥Ú¡¼¥¸¤È¤·¤Æ¥í¡¼¥É¤·¤Þ¤¹¡£
.LP
.TP 2
\(bu
.B index.html
(¥Õ¥ì¡¼¥à¤¢¤ê)
.TP 2
\(bu
.B overview-summary.html
(¥Õ¥ì¡¼¥à¤Ê¤·)
.SS "À¸À®¤µ¤ì¤ë¥Õ¥¡¥¤¥ë¹½Â¤"
À¸À®¤µ¤ì¤ë¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¥Õ¥¡¥¤¥ë¤Ï¡¢Java ¥½¡¼¥¹
¥Õ¥¡¥¤¥ë¤ª¤è¤Ó¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤ÈƱ¤¸¥Ç¥£¥ì¥¯¥È¥ê³¬ÁؤÇÁÈ¿¥
¤µ¤ì¤Þ¤¹¡£¤³¤Î¹½Â¤¤Ï¡¢1 ¤Ä¤Î¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤Ë¤Ä¤­ 1 ¤Ä¤Î¥Ç¥£¥ì¥¯¥È¥ê
¤Ç¹½À®¤µ¤ì¤Þ¤¹¡£
.LP
¤¿¤È¤¨¤Ð¡¢
.B java.applet.Applet
¥¯¥é¥¹¤ËÂФ·¤ÆÀ¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤Ï¡¢
.BR java/applet/Applet.html
¤Ë³ÊǼ¤µ¤ì¤Þ¤¹¡£À¸À®Àè¤Î¥Ç¥£¥ì¥¯¥È¥ê¤Î̾Á°¤¬ apidocs ¤À¤È
¤¹¤ë¤È¡¢java.applet ¥Ñ¥Ã¥±¡¼¥¸¤Î¥Õ¥¡¥¤¥ë¹½Â¤¤â¤³¤ì¤Ë½¾¤¤¤Þ¤¹¡£
Á°½Ò¤·¤¿¤è¤¦¤Ë¡¢¡Öframe¡×¤È¤¤¤¦¸ì¤ò̾Á°¤Ë´Þ¤à¥Õ¥¡¥¤¥ë¤Ï¡¢
¤¹¤Ù¤Æº¸¾å¤Þ¤¿¤Ïº¸²¼¤Î¥Õ¥ì¡¼¥à¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£¤½¤ì
°Ê³°¤Î HTML ¥Õ¥¡¥¤¥ë¤Ï¡¢¤¹¤Ù¤Æ±¦Â¦¤Î¥Õ¥ì¡¼¥à¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£
.LP
Ãí: ¥Ç¥£¥ì¥¯¥È¥ê¤Ï¡¢ÂÀ»ú (bold) ¤Ç¼¨¤·¤Æ¤¢¤ê¤Þ¤¹¡£
¥¢¥¹¥¿¥ê¥¹¥¯ (*) ¤Ï¡¢
.B javadoc
¤Ø¤Î°ú¿ô¤¬¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Ç¤Ê¤¯¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾ (*\f3.java\f1) ¤Î
¤È¤­¤Ë¡¢¾Êά¤µ¤ì¤ë¥Õ¥¡¥¤¥ë¤ª¤è¤Ó¥Ç¥£¥ì¥¯¥È¥ê¤ò¼¨¤·¤Æ¤¤¤Þ¤¹¡£¤Þ¤¿¡¢
°ú¿ô¤¬¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤Î¤È¤­¤Ë¤Ï¡¢
.B package-list
¤ÏºîÀ®¤µ¤ì¤Þ¤¹¤¬¡¢¶õ¤Ç¤¹¡£
.B doc-files
¥Ç¥£¥ì¥¯¥È¥ê¤Ï¡¢¥½¡¼¥¹¥Ä¥ê¡¼Æâ¤Ë¸ºß¤·¤Ê¤¤¸Â¤ê¡¢À¸À®Àè¤Ëɽ¼¨¤µ¤ì¤Þ¤»¤ó¡£
.LP
.RE
.nf
\f3
.fl
.fl
\fP\f3apidocs\fP ºÇ¾å°Ì¥Ç¥£¥ì¥¯¥È¥ê
.fl
index.html HTML ¥Õ¥ì¡¼¥à¤òÀßÄꤹ¤ë½é´ü¥Ú¡¼¥¸
.fl
* overview\-summary.html Á´¥Ñ¥Ã¥±¡¼¥¸¤Î¥ê¥¹¥È¡£ÀèƬ¤ËÍ×Ìóʸ¤¬¤¢¤ë
.fl
overview\-tree.html Á´¥Ñ¥Ã¥±¡¼¥¸¤Î¥¯¥é¥¹³¬ÁؤΥꥹ¥È
.fl
deprecated\-list.html Á´¥Ñ¥Ã¥±¡¼¥¸¤Î¿ä¾©¤µ¤ì¤Ê¤¤ API ¤Î¥ê¥¹¥È
.fl
constant\-values.html Á´¥Ñ¥Ã¥±¡¼¥¸¤Î static ¥Õ¥£¡¼¥ë¥É¤ÎÃͤΥꥹ¥È
.fl
serialized\-form.html Á´¥Ñ¥Ã¥±¡¼¥¸¤ÎľÎ󲽤µ¤ì¤¿·Á¼°¤Î¥ê¥¹¥È
.fl
* overview\-frame.html Á´¥Ñ¥Ã¥±¡¼¥¸¤Î¥ê¥¹¥È¡£º¸¾å¤Î¥Õ¥ì¡¼¥à¤Ëɽ¼¨¤µ¤ì¤ë
.fl
allclasses\-frame.html Á´¥Ñ¥Ã¥±¡¼¥¸¤ÎÁ´¥¯¥é¥¹¤Î¥ê¥¹¥È¡£º¸²¼¤Î¥Õ¥ì¡¼¥à¤Ëɽ¼¨¤µ¤ì¤ë
.fl
help\-doc.html ¤³¤ì¤é¤Î¥Ú¡¼¥¸¤Î¹½À®¤ò¼¨¤¹¥æ¡¼¥¶¥Ø¥ë¥×¤òɽ¼¨¤¹¤ë
.fl
index\-all.html \-splitindex ¥ª¥×¥·¥ç¥ó¤Ê¤·¤ÇºîÀ®¤µ¤ì¤¿¥Ç¥Õ¥©¥ë¥Èº÷°ú
.fl
\f3index\-files\fP \-splitindex ¥ª¥×¥·¥ç¥ó¤ò»ØÄꤷ¤ÆºîÀ®¤µ¤ì¤¿¥Ç¥£¥ì¥¯¥È¥ê
.fl
index\-<number>.html \-splitindex ¥ª¥×¥·¥ç¥ó¤ò»ØÄꤷ¤ÆºîÀ®¤µ¤ì¤¿º÷°ú¥Õ¥¡¥¤¥ë
.fl
package\-list ¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Î¥ê¥¹¥È¡£³°Éô»²¾È¤ò²ò·è¤¹¤ë¤¿¤á¤À¤±¤Ë»ÈÍѤµ¤ì¤ë
.fl
stylesheet.css ¥Õ¥©¥ó¥È¡¢¿§¡¢ÇÛÃÖ¤òÄêµÁ¤¹¤ë HTML ¥¹¥¿¥¤¥ë¥·¡¼¥È
.fl
\f3java\fP ¥Ñ¥Ã¥±¡¼¥¸¥Ç¥£¥ì¥¯¥È¥ê
.fl
\f3applet\fP ¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¥Ç¥£¥ì¥¯¥È¥ê
.fl
Applet.html Applet ¥¯¥é¥¹¤Î¥Ú¡¼¥¸
.fl
AppletContext.html AppletContext ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥Ú¡¼¥¸
.fl
AppletStub.html AppletStub ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥Ú¡¼¥¸
.fl
AudioClip.html AudioClip ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥Ú¡¼¥¸
.fl
* package\-summary.html ¤³¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥¯¥é¥¹¤Î¥ê¥¹¥È¡£ÀèƬ¤ËÍ×Ìóʸ¤¬¤¢¤ë
.fl
* package\-frame.html ¤³¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥¯¥é¥¹¤Î¥ê¥¹¥È¡£º¸²¼¤Î¥Õ¥ì¡¼¥à¤Ëɽ¼¨¤µ¤ì¤ë
.fl
* package\-tree.html ¤³¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥¯¥é¥¹³¬ÁؤΥꥹ¥È
.fl
package\-use ¤³¤Î¥Ñ¥Ã¥±¡¼¥¸¤¬»ÈÍѤµ¤ì¤Æ¤¤¤ë¾ì½ê¤Î¥ê¥¹¥È
.fl
\f3doc\-files\fP ¥¤¥á¡¼¥¸¤ä¥µ¥ó¥×¥ë¤Î¥Õ¥¡¥¤¥ë¤¬³ÊǼ¤µ¤ì¤ë¥Ç¥£¥ì¥¯¥È¥ê
.fl
\f3class\-use\fP API ¤¬»ÈÍѤµ¤ì¤Æ¤¤¤ë¾ì½ê¤Î¥Ú¡¼¥¸¤ò³ÊǼ¤¹¤ë¥Ç¥£¥ì¥¯¥È¥ê
.fl
Applet.html Applet ¥¯¥é¥¹¤ò»ÈÍѤ¹¤ë¥Ú¡¼¥¸
.fl
AppletContext.html AppletContext ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ò»ÈÍѤ¹¤ë¥Ú¡¼¥¸
.fl
AppletStub.html AppletStub ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ò»ÈÍѤ¹¤ë¥Ú¡¼¥¸
.fl
AudioClip.html AudioClip ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ò»ÈÍѤ¹¤ë¥Ú¡¼¥¸
.fl
\f3src\-html\fP ¥½¡¼¥¹¥³¡¼¥É¥Ç¥£¥ì¥¯¥È¥ê
.fl
\f3java\fP ¥Ñ¥Ã¥±¡¼¥¸¥Ç¥£¥ì¥¯¥È¥ê
.fl
\f3applet\fP ¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¥Ç¥£¥ì¥¯¥È¥ê
.fl
Applet.html Applet ¥½¡¼¥¹¥³¡¼¥É¤Î¥Ú¡¼¥¸
.fl
AppletContext.html AppletContext ¥½¡¼¥¹¥³¡¼¥É¤Î¥Ú¡¼¥¸
.fl
AppletStub.html AppletStub ¥½¡¼¥¹¥³¡¼¥É¤Î¥Ú¡¼¥¸
.fl
AudioClip.html AudioClip ¥½¡¼¥¹¥³¡¼¥É¤Î¥Ú¡¼¥¸
.fl
.fi
.LP
.SS "À¸À®¤µ¤ì¤ë API Àë¸À"
javadoc ¥Ä¡¼¥ë¤Ï¡¢³Æ¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥Õ¥£¡¼¥ë¥É¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢
¤ª¤è¤Ó¥á¥½¥Ã¥É¤ÎÀâÌÀ¤Î½é¤á¤ÇÀë¸À¤òÀ¸À®¤·¤Þ¤¹¡£
¤³¤ÎÀë¸À¤Ï¡¢¤½¤Î API ¹àÌܤÎÀë¸À¤Ç¤¹¡£¤¿¤È¤¨¤Ð¡¢
¥Ö¡¼¥ë·¿¥¯¥é¥¹¤ÎÀë¸À¤Ï¼¡¤Î¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
.LP
\f2public final class Boolean\fP
.br
\f2extends Object\fP
.br
\f2implements Serializable\fP
.LP
.LP
Boolean.valueOf ¥á¥½¥Ã¥É¤ÎÀë¸À¤Ï¼¡¤Î¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
.LP
\f2public static Boolean valueOf(String s)\fP
.LP
.LP
javadoc ¥Ä¡¼¥ë¤Ï½¤¾þ»Ò
.BR public
¡¢
.BR protected
¡¢
.BR private
¡¢
.BR abstract
¡¢
.BR final
¡¢
.BR static
¡¢
.BR transient
¡¢
¤ª¤è¤Ó
.BR volatile
¤òÁȤ߹þ¤à¤³¤È¤¬¤Ç¤­¤Þ¤¹¤¬¡¢
.BR synchronized
¤È
.BR native
¤ÏÁȤ߹þ¤à¤³¤È¤¬¤Ç¤­¤Þ¤»¤ó¡£
.BR synchronized
¤È
.BR native
½¤¾þ»Ò¤Ï¼ÂÁõ¤Î¾ÜºÙ¤È¸«¤Ê¤µ¤ì¡¢API »ÅÍͤΰìÉô¤È¤Ï¸«¤Ê¤µ¤ì¤Þ¤»¤ó¡£
.LP
¥­¡¼¥ï¡¼¥É
.BR synchronized
¤Ë°Í¸¤¹¤ë¤è¤ê¤â¡¢¡ÖÊ£¿ô¤Î¥¹¥ì¥Ã¥É¤Ë¤è¤Ã¤Æñ°ì¤Î
.BR Enumeration
¤òʹԤ·¤Æ»ÈÍѤ·¤Æ¤Ï¤Ê¤é¤Ê¤¤¡×¤È¤¤¤¦¤è¤¦¤Ë¡¢Ê¹ԽèÍý¤Î¥»¥Þ¥ó¥Æ¥£¥Ã¥¯¥¹¤ò
¥³¥á¥ó¥ÈÀâÌÀ¤ÎÃæ¤Ç¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¤Ù¤­¤Ç¤¹¡£¥É¥­¥å¥á¥ó¥È¤Ç¤Ï¡¢
¤³¤ì¤é¤Î¥»¥Þ¥ó¥Æ¥£¥Ã¥¯¥¹¤ÎãÀ®ÊýË¡¤òÀâÌÀ¤¹¤Ù¤­¤Ç¤Ï¤¢¤ê¤Þ¤»¤ó¡£Ê̤Î
Îã¤òµó¤²¤ë¤È¡¢
.BR Hashtable
¤Ï¥¹¥ì¥Ã¥É¤ËÂФ·¤Æ°ÂÁ´¤Ç¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¤¬¡¢¥¨¥¯¥¹¥Ý¡¼¥È¤µ¤ì¤ë¤½¤Î
¥á¥½¥Ã¥É¤¹¤Ù¤Æ¤òƱ´ü¤µ¤»¤ë¤³¤È¤Ë¤è¤Ã¤Æ¤³¤ì¤ò¼Â¸½¤¹¤ë¤ÈÌÀµ­¤¹¤ëɬÍ×
¤Ï¤Ê¤¤¤È¤¤¤¦¤³¤È¤Ç¤¹¡£¥Ð¥±¥Ã¥È¥ì¥Ù¥ë¤ÇÆâÉôŪ¤ËƱ´ü¤ò¤È¤ë¸¢¸Â¤òαÊݤ·¤Æ¡¢
¤è¤ê¹âÅÙ¤ÊʹÔÀ­¤òÄ󶡤¹¤Ù¤­¤Ç¤¹¡£
.LP
.SH "¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È"
.LP
.LP
¥ª¥ê¥¸¥Ê¥ë¤Î¡Ö¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Î»ÅÍ͡פϡ¢¡Ö´ØÏ¢¹àÌܡפò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.SS
¥½¡¼¥¹¥³¡¼¥É¤Ø¤Î¥³¥á¥ó¥È¤ÎÁÞÆþ
.LP
.LP
¥½¡¼¥¹¥³¡¼¥É¤ÎǤ°Õ¤ÎÀë¸À (¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥á¥½¥Ã¥É¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢
¤Þ¤¿¤Ï¥Õ¥£¡¼¥ë¥É) ¤ÎÁ°¤Ë¡¢¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È (doc ¥³¥á¥ó¥È)
¤òµ­½Ò¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£ ³Æ¥Ñ¥Ã¥±¡¼¥¸¤Ë¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò
ºîÀ®¤Ç¤­¡¢¹½Ê¸¤Ï¼ã´³°Û¤Ê¤ê¤Þ¤¹¤¬¡¢³µÍפˤâ¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò
ºîÀ®¤Ç¤­¤Þ¤¹¡£ ¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ï¡¢Javadoc ¥³¥á¥ó¥È¤È¤â¸Æ¤Ð¤ì¤Þ¤¹¡£
¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ï¡¢¥³¥á¥ó¥È¤Î»Ï¤Þ¤ê¤ò¼¨¤¹Ê¸»úÎó
.B /**
¤È¡¢¥³¥á¥ó¥È¤Î½ª¤ï¤ê¤ò¼¨¤¹Ê¸»úÎó
.B */
¤Î´Ö¤Ë¤¢¤ëʸ»ú¤Ç¹½À®¤µ¤ì¤Þ¤¹¡£ ¹ÔƬ¤Î¥¢¥¹¥¿¥ê¥¹¥¯¤Ï¡¢³Æ¹Ô¤Ëµ­½Ò¤Ç¤­¤Þ¤¹¡£¾ÜºÙ¤Ï¡¢°Ê²¼¤ÇÀâÌÀ¤·¤Þ¤¹¡£ Linux ¤Ç¤Ï¥Æ¥­¥¹¥È¤Ï¡¢Ê£¿ô¹Ô¤Ë¤ï¤¿¤Ã¤Æµ­½Ò¤Ç¤­¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
/**
* This is the typical format of a simple documentation comment
* that spans two lines.
*/
.fi
.ft 1
.RE
.LP
¼¡¤Î¤è¤¦¤Ë¡¢¥³¥á¥ó¥È¤Ï 1 ¹Ô¤Ë¤Þ¤È¤á¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
/** This comment takes up only one line. */
.fi
.ft 1
.RE
.LP
¥³¥á¥ó¥È¤ÎÇÛÃÖ - ¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤¬Ç§¼±¤µ¤ì¤ë¤Î¤Ï¡¢¥¯¥é¥¹¡¢
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¤Þ¤¿¤Ï¥Õ¥£¡¼¥ë¥É
Àë¸À¤ÎÁ°¤ËÃÖ¤«¤ì¤¿¾ì¹ç¤À¤±¤Ç¤¹ (¥¯¥é¥¹¡¢¥á¥½¥Ã¥É¡¢¤ª¤è¤Ó¥Õ¥£¡¼¥ë¥É¤Î
Îã¤ò»²¾È)¡£¥á¥½¥Ã¥É¤ÎËÜÂΤËÃÖ¤«¤ì¤¿¥É¥­¥å¥á¥ó¥È
¥³¥á¥ó¥È¤Ï̵»ë¤µ¤ì¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢Àë¸Àʸ¤´¤È¤Ë 1 ¤Ä¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤À¤±¤ò
ǧ¼±¤·¤Þ¤¹¡£
.LP
¤è¤¯È¯À¸¤¹¤ë´Ö°ã¤¤¤Ï¡¢½ÅÍפÊʸ¤ò¥¯¥é¥¹¥³¥á¥ó¥È¤È¥¯¥é¥¹Àë¸À¤Î´Ö¤Ë
Æþ¤ì¤Æ¤·¤Þ¤¦¤³¤È¤Ç¤¹¡£
.B javadoc
¤Ï¥¯¥é¥¹¥³¥á¥ó¥È¤ò̵»ë¤¹¤ë¤¿¤á¡¢Ãí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.RS
.ft 3
.nf
/**
* This is the class comment for the class Whatever.
*/
import com.sun; // MISTAKE - Important not to put statements here
public class Whatever {
}
.fi
.ft 1
.RE
.LP
¥³¥á¥ó¥È¤ÎÀâÌÀ¤Î¤¢¤È¤Ë¥¿¥°¤¬Â³¤¯ - ¥³¥á¥ó¥È¤Î³«»Ï¶èÀÚ¤êʸ»ú¤Ç¤¢¤ë
.B /**
¤Î¤¢¤È¤«¤é¥¿¥°¥»¥¯¥·¥ç¥ó¤Þ¤Ç¤¬ÀâÌÀ¤Ë¤Ê¤ê¤Þ¤¹¡£ ¥¿¥°¥»¥¯¥·¥ç¥ó¤Ï¡¢
ÀèƬʸ»ú¤¬
.B @
¤Ç¤¢¤ë¹Ô¤«¤é»Ï¤Þ¤ê¤Þ¤¹ (¹Ô¤ÎÀèƬ¤Î¥¢¥¹¥¿¥ê¥¹¥¯¤ª¤è¤Ó¶õÇòʸ»ú
¤Ï½ü¤¯)¡£ ÀâÌÀ¤òµ­½Ò¤»¤º¡¢¥³¥á¥ó¥È¤À¤±¤Î¥¿¥°¤òµ­½Ò¤¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
ÀâÌÀ¤Ï¡¢¥¿¥°¥»¥¯¥·¥ç¥ó°Ê¹ß¤Ë³¤±¤ë¤³¤È¤Ï¤Ç¤­¤Þ¤»¤ó¡£
¥¿¥°¤Î°ú¿ô¤ÏÊ£¿ô¤Î¹Ô¤Ë¤Þ¤¿¤¬¤Ã¤Æµ­½Ò¤Ç¤­¤Þ¤¹¡£ ¥¿¥°¤Î¿ô¤Ë
À©¸Â¤Ï¤¢¤ê¤Þ¤»¤ó¡£²¿²ó¤âµ­½Ò¤Ç¤­¤ë¥¿¥°¤È¡¢1 ²ó¤·¤«µ­½Ò¤Ç¤­¤Ê¤¤
¥¿¥°¤¬¤¢¤ê¤Þ¤¹¡£ ¼¡¤ÎÎã¤Î
.B @see
¤«¤é¥¿¥°¥»¥¯¥·¥ç¥ó¤¬»Ï¤Þ¤ê¤Þ¤¹¡£
.LP
.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
.LP
ɸ½à¥¿¥°¤È¥¤¥ó¥é¥¤¥ó¥¿¥°: ¥¿¥°¤Ï¡¢javadoc ¥Ä¡¼¥ë¤¬½èÍý¤Ç¤­¤ë¡¢
doc ¥³¥á¥ó¥ÈÆâ¤ÎÆÃÊ̤ʥ­¡¼¥ï¡¼¥É¤Ç¤¹¡£javadoc ¥Ä¡¼¥ë¤Ë¤Ï¡¢@tag ¤È¤·¤Æ¸½¤ì¤ë
ɸ½à¥¿¥°¤È¡¢Ãæ³ç¸ÌÆâ¤Ë
.B {\f3@tag\f1}
¤È¤·¤Æ¸½¤ì¤ë¥¤¥ó¥é¥¤¥ó¥¿¥°¤¬¤¢¤ê¤Þ¤¹¡£²ò¼á
¤µ¤»¤ë¤¿¤á¤Ë¤Ï¡¢ÀèƬ¤Î¥¢¥¹¥¿¥ê¥¹¥¯¡¢¶õÇò¡¢¥³¥á¥ó¥È¶èÀÚ¤êʸ»ú (/**) ¤ò
½ü¤¤¤Æ¤Ïɸ½à¥¿¥°¤¬¹Ô¤ÎÀèƬ¤Ç¤¢¤ë¤è¤¦¤ËÇÛÃÖ¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£¤Ä
¤Þ¤ê¡¢¥æ¡¼¥¶¤Ï¥Æ¥­¥¹¥ÈÆâ¤ÎǤ°Õ¤Î°ÌÃÖ¤Ç @ ʸ»ú¤ò»ÈÍѤǤ­¡¢
¤³¤Îʸ»ú¤Ï¥¿¥°¤Î»Ï¤á¤È¤Ï²ò¼á¤µ¤ì¤Þ¤»¤ó¡£@ ʸ»ú¤Ç¹Ô¤ò³«
»Ï¤·¤Æ¤³¤ì¤¬²ò¼á¤µ¤ì¤Ê¤¤¤è¤¦¤Ë¤·¤¿¤¤¾ì¹ç¤Ï¡¢HTML ¥¨¥ó¥Æ¥£¥Æ¥£¤Î
&#064; ¤ò»ÈÍѤ·¤Æ¤¯¤À¤µ¤¤¡£³Æ¥¹¥¿¥ó¥É¥¢¥í¥ó¥¿¥°¤Ë¤Ï´ØÏ¢¤¹¤ë¥Æ¥­¥¹¥È¤¬¤¢¤ê
¤Þ¤¹¡£¤³¤ì¤Ï¡¢¤½¤Î¥¿¥°¤Î¸å¤«¤é¼¡¤Î¥¿¥°¤ÎľÁ°¤Þ¤Ç¡¢¤Þ¤¿¤Ï doc ¥³¥á¥ó¥È
¤ÎºÇ¸å¤Þ¤Ç¤ÎǤ°Õ¤Î¥Æ¥­¥¹¥È¤Ç¤¹¡£´ØÏ¢ÉÕ¤±¤é¤ì¤¿¥Æ¥­¥¹¥È¤Ï¡¢
Ê£¿ô¹Ô¤Ë¤Þ¤¿¤¬¤Ã¤Æµ­½Ò¤Ç¤­¤Þ¤¹¡£
¥¤¥ó¥é¥¤¥ó¥¿¥°¤Ï¡¢¤½¤Î¥Æ¥­¥¹¥È¤¬µö
²Ä¤µ¤ì¤ë°ÌÃ֤ˤϤɤ³¤Ç¤â»ØÄê¤Ç¤­¡¢²ò¼á¤ÎÂоݤȤʤê¤Þ¤¹¡£¼¡¤ÎÎã¤Ï¡¢
ɸ½à¥¿¥°
.BR @deprecated
¤È¥¤¥ó¥é¥¤¥ó¥¿¥°
.BR {@link}
¤¬´Þ¤Þ¤ì¤Æ¤¤¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
/**
* @deprecated As of JDk 1.1, replaced by {@link #setBounds(int,int,int,int)}
*/
.fi
.ft 1
.RE
.LP
¥³¥á¥ó¥È¤Ï HTML ¤Çµ­½Ò¤·¤Þ¤¹¡£¥Æ¥­¥¹¥È¤Ï HTML ¤Ç
µ­½Ò¤·¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
¤³¤ì¤Ï¡¢HTML ¤Î¥¨¥ó¥Æ¥£¥Æ¥£¤ò»È¤¦É¬Íפ¬¤¢¤ë¤³¤È¡¢
¤ª¤è¤Ó HTML ¥¿¥°¤ò»ÈÍѤǤ­¤ë¤³¤È
¤ò°ÕÌ£¤·¤Þ¤¹¡£HTML ¤Ï¡¢»ÈÍѤ¹¤ë¥Ö¥é¥¦¥¶¤¬¥µ¥Ý¡¼¥È¤¹¤ë
Ǥ°Õ¤Î¥Ð¡¼¥¸¥ç¥ó¤ò»È¤¦¤³¤È¤¬
¤Ç¤­¤Þ¤¹¡£É¸½à¥É¥Ã¥¯¥ì¥Ã¥È¤Ï¡¢³¬Áؼ°¥¹¥¿¥¤¥ë¥·¡¼¥È¤È
¥Õ¥ì¡¼¥à¤ò´Þ¤à¤Û¤«¤ÎÉôʬ (¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È
°Ê³°) ¤Ï¡¢HTML 3.2 ¤Ë½àµò¤·¤¿¥³¡¼¥É¤òÀ¸À®¤¹¤ë¤è¤¦¤Ëµ­½Ò
¤µ¤ì¤Æ¤¤¤Þ¤¹
(¥Õ¥ì¡¼¥à¥»¥Ã¥ÈÂбþ¤Î¤¿¤á¡¢À¸À®¤µ¤ì¤ë³Æ
¥Õ¥¡¥¤¥ë¤Ï¡¢¡ÖHTML 4.0¡×¤Ç»Ï¤Þ¤ë)¡£
.LP
¤¿¤È¤¨¤Ð¡¢¤è¤ê¾®¤µ¤¤ (<) ¤ª¤è¤Ó¤è¤êÂ礭¤¤ (>) ¤È¤¤¤¦
µ­¹æ¤Ï¡¢
.B &lt;
¤È
.BR &gt;
¤Èµ­½Ò¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£Æ±Íͤˡ¢¥¢¥ó¥Ñ¥µ¥ó¥É (&) ¤Ï¡¢
.BR &amp;
¤Èµ­½Ò¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£¼¡¤ÎÎã¤Ç
¤Ï¡¢¥Ü¡¼¥ë¥É¤Î HTML ¥¿¥° <b> ¤ò¼¨¤·¤Þ¤¹¡£
.LP
¼¡¤Ë doc ¥³¥á¥ó¥È¤ò¼¨¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
/**
* This is a <b>doc</b> comment.
* @see java.lang.Object
*/
.fi
.ft 1
.RE
.LP
¹ÔƬ¤Î¥¢¥¹¥¿¥ê¥¹¥¯ -
.B javadoc
¤Ï¡¢doc ¥³¥á¥ó¥È¤ò²òÀϤ¹¤ë¤È¤­¤Ë¡¢³Æ¹Ô¤ÎÀèƬ¤Ë¤¢¤ë
ʸ»ú¥¢¥¹¥¿¥ê¥¹¥¯ (*) ¤ò¤¹¤Ù¤ÆÇË´þ¤·
¤Þ¤¹¡£¤Þ¤¿¡¢ºÇ½é¤Î¥¢¥¹¥¿¥ê¥¹¥¯ (*) ¤è¤êÁ°¤Î¶õÇò¤È
¥¿¥Ö¤âÇË´þ¤·¤Þ¤¹¡£1.4 ¤«¤é¤Ï¡¢¹ÔƬ¤Î¥¢¥¹¥¿¥ê¥¹¥¯¤ò¾Êά¤·¤¿¾ì¹ç¡¢¹ÔƬ¤Î¶õÇò¤Ïºï½ü¤µ¤ì¤Þ¤»¤ó¡£¤³¤ì¤Ë¤è¤ê¡¢<PRE> ¥¿¥°¤ÎÃæ¤Î doc ¥³¥á¥ó¥È¤Ë¡¢¥µ¥ó¥×¥ë¥³¡¼¥É¤ò¥¤¥ó¥Ç¥ó¥È¤ò»Ä¤·¤¿¤Þ¤Þ¤ÇľÀÜ¥Ú¡¼¥¹¥È¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¶õÇò¤Ï°ìÈÌŪ¤Ë¡¢¥¿¥Ö¤è¤ê¤â¶Ñ°ì¤Ë¥Ö¥é¥¦¥¶¤Ç²ò¼á¤µ¤ì¤Þ¤¹¡£¥¤¥ó¥Ç¥ó¥È¤Ï¡¢¶èÀÚ¤êʸ»ú /** ¤ä <PRE> ¥¿¥°¤Ç¤Ï¤Ê¤¯¡¢º¸¥Þ¡¼¥¸¥ó¤ËÁêÂÐŪ¤Ç¤¹¡£
.LP
ºÇ½é¤Îʸ - ³Æ doc ¥³¥á¥ó¥È¤ÎºÇ½é¤Îʸ¤Ï¡¢Àë¸À¤µ¤ì¤Æ¤¤¤ë
¥¨¥ó¥Æ¥£¥Æ¥£¤Ë´Ø¤¹¤ë´Ê·é¤«¤Ä´°Á´
¤ÊÀâÌÀ¤ò´Þ¤àÍ×Ìóʸ¤Ç¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
¤³¤Îʸ¤Ï¡¢¶õÇò¡¢¥¿¥Ö¡¢¤Þ¤¿¤Ï¹ÔËöµ­
¹æ¤¬Â³¤¤¤Æ¤¤¤ëºÇ½é¤Î¥Ô¥ê¥ª¥É¡¢¤¢¤ë¤¤¤ÏºÇ½é¤Î¥¹¥¿¥ó¥É¥¢¥í¥ó¥¿¥°¤Ç½ªÎ»¤·¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢HTML ¥Ú¡¼¥¸¤ÎºÇ½é¤Ë¤¢¤ë¥á¥ó¥ÐÍ×Ìó¤Ë¡¢¤³¤ÎºÇ½é¤Îʸ¤ò¥³¥Ô¡¼¤·¤Þ¤¹¡£
.LP
Ê£¿ô¥Õ¥£¡¼¥ë¥É¤ÎÀë¸À -
.B java
¤Ç¤Ï¡¢Ã±°ì¤Îʸ¤ÇÊ£¿ô¤Î¥Õ¥£¡¼¥ë¥É¤òÀë¸À¤Ç¤­¤Þ¤¹¡£
¤·¤«¤·¡¢¤³¤Îʸ¤Î¥É¥­¥å¥á¥ó¥Æ
¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ï 1 ¤Ä¤À¤±¤Ç¡¢¤³¤Î¥³¥á¥ó¥È¤¬
¤¹¤Ù¤Æ¤Î¥Õ¥£¡¼¥ë¥É¤Ë¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£
¤·¤¿¤¬¤Ã¤Æ¡¢¥Õ¥£¡¼¥ë¥É¤´¤È¤Ë¸Ä¡¹¤Î
¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤òÉÕ¤±¤¿¤¤¾ì¹ç¤Ï¡¢
³Æ¥Õ¥£¡¼¥ë¥É¤ò°Û¤Ê¤ëʸ¤ÇÀë¸À¤·¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
¤¿¤È¤¨¤Ð¡¢¼¡¤Î¥É¥­¥å¥á¥ó¥Æ¡¼
¥·¥ç¥ó¥³¥á¥ó¥È¤Ïñ°ì¤ÎÀë¸À¤È¤·¤Æ¤Ï°ÕÌ£¤òÀ®¤µ¤º¡¢
2 ¤Ä¤ÎÀë¸À¤È¤·¤Æ½èÍý¤¹¤ë¤Ù¤­
¤Ç¤¹¡£
.LP
.RS
.ft 3
.nf
/**
* The horizontal and vertical distances of point (x,y)
*/
public int x, y; // Avoid this
.fi
.ft 1
.RE
.LP
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¾åµ­¥³¡¼¥É¤«¤é¼¡¤Î¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
public int x
.fi
.ft 1
The horizontal and vertical distances of point
(x,y).
.ft 3
.nf
public int y
.fi
.ft 1
The horizontal and vertical distances of point
(x,y).
.RE
.LP
¥Ø¥Ã¥À¥¿¥°¤ò»ÈÍѤ¹¤ë¤È¤­¤ÏÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£
¥á¥ó¥ÐÍѤΥɥ­¥å¥á¥ó¥È¥³
¥á¥ó¥È¤ò½ñ¤¯¤È¤­¤Ï¡¢
.B <H1>
¤ä
.BR <H2>
¤Ê¤É¤Î HTML ¥Ø¥Ã¥À¥¿¥°¤ò»ÈÍѤ·¤Ê¤¤¤Ç¤¯¤À¤µ¤¤¡£¤³¤ì¤Ï¡¢
.B javadoc
¤¬Á´¥É¥­¥å¥á¥ó¥È¤ò¹½Â¤²½¤·¤ÆÀ¸À®¤¹¤ë¤¿¤á¡¢
¤³¤ì¤é¤Î¹½Â¤²½¥¿¥°¤ò»ÈÍѤ¹¤ë¤È¡¢
¥É¥­¥å¥á¥ó¥È¤Î½ñ¼°¤¬Íð¤ì¤ë²ÄǽÀ­¤¬¤¢¤ë¤¿¤á¤Ç¤¹¡£
¤·¤«¤·¡¢¥¯¥é¥¹¤ä¥Ñ¥Ã¥±¡¼¥¸¤Î
¥³¥á¥ó¥È¤Ç¤Ï¡¢¤³¤ì¤é¤Î¥Ø¥Ã¥À¥¿¥°¤ò»ÈÍѤ·¤Æ¹½Â¤²½¤ò»Ø¼¨¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
¥á¥½¥Ã¥É¥³¥á¥ó¥È¤Î¼«Æ°¥³¥Ô¡¼
.LP
.LP
Javadoc ¥Ä¡¼¥ë¤Ë¤Ï¡¢¼¡¤Î 2 ¤Ä¤Î¾ì¹ç¤Ë¡¢¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥á¥½¥Ã¥É¥³¥á¥ó¥È¤ò¥³¥Ô¡¼¤Þ¤¿¤Ï¡Ö·Ñ¾µ¡×¤¹¤ëµ¡Ç½¤¬¤¢¤ê¤Þ¤¹¡£¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥Õ¥£¡¼¥ë¥É¡¢¤ª¤è¤ÓÆþ¤ì»Ò¤Î¥¯¥é¥¹¤Ï¡¢¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò·Ñ¾µ¤·¤Þ¤»¤ó¡£
.LP
.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
.LP
¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò¼ÂºÝ¤Ë¥³¥Ô¡¼¤ËÍøÍѤ¹¤ë¤Ë¤Ï¡¢·Ñ¾µ¤·¤¿¥á¥½¥Ã¥É¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤¬ \-sourcepath ¤Ç»ØÄꤷ¤¿¥Ñ¥¹¤À¤±¤ËÃÖ¤«¤ì¤Æ¤¤¤ë¤³¤È¤¬É¬Íפˤʤê¤Þ¤¹¡£¥³¥Þ¥ó¥É¹Ô¤Ç¡¢¥¯¥é¥¹¤â¥Ñ¥Ã¥±¡¼¥¸¤âÅϤ¹É¬ÍפϤ¢¤ê¤Þ¤»¤ó¡£¤³¤ÎÅÀ¤Ï¡¢¥¯¥é¥¹¤¬ ¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤«¤Ã¤¿ 1.3.x °ÊÁ°¤Î¥ê¥ê¡¼¥¹¤È°Û¤Ê¤ê¤Þ¤¹¡£
.LP
.LP
\f3¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤«¤é¤Î·Ñ¾µ\fP \- ¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤«¤é·Ñ¾µ¤¹¤ë¼¡¤Î 3 ¤Ä¤Î¾ì¹ç¤Ë¡¢¥³¥á¥ó¥È¤Î·Ñ¾µ¤¬¹Ô¤ï¤ì¤Þ¤¹¡£
.LP
.RS 3
.TP 2
o
¥¯¥é¥¹¤Î¥á¥½¥Ã¥É¤¬¥¹¡¼¥Ñ¡¼¥¯¥é¥¹¤Î¥á¥½¥Ã¥É¤ò¥ª¡¼¥Ð¡¼¥é¥¤¥É¤·¤Æ¤¤¤ë
.TP 2
o
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥á¥½¥Ã¥É¤¬¥¹¡¼¥Ñ¡¼¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥á¥½¥Ã¥É¤ò¥ª¡¼¥Ð¡¼¥é¥¤¥É¤·¤Æ¤¤¤ë
.TP 2
o
¥¯¥é¥¹¤Î¥á¥½¥Ã¥É¤¬¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥á¥½¥Ã¥É¤ò¼ÂÁõ¤·¤Æ¤¤¤ë
.RE
.LP
.LP
ºÇ½é¤Î 2 ¤Ä¤Î¥±¡¼¥¹ (¥á¥½¥Ã¥É¤¬¥ª¡¼¥Ð¡¼¥é¥¤¥É¤·¤Æ¤¤¤ë¾ì¹ç) ¤Ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥ª¡¼¥Ð¡¼¥é¥¤¥É¤·¤Æ¤¤¤ë¥á¥½¥Ã¥É¤Î¥É¥­¥å¥á¥ó¥ÈÆâ¤Ë
¡Ö¥ª¡¼¥Ð¡¼¥é¥¤¥É¡×¤È¤¤¤¦¾®¸«½Ð¤·¤òÀ¸À®¤·¡¢¥³¥á¥ó¥È¤¬·Ñ¾µ¤µ¤ì¤Æ¤¤¤ë¤«¤É¤¦¤«¤Ë¤«¤«¤ï¤é¤º¡¢¥ª¡¼¥Ð¡¼¥é¥¤¥É¤µ¤ì¤Æ¤¤¤ë
¥á¥½¥Ã¥É¤Ø¤Î¥ê¥ó¥¯¤ò½ñ¤­¹þ¤ß¤Þ¤¹¡£
.LP
3 ¤ÄÌܤΥ±¡¼¥¹ (ÆÃÄê¤Î¥¯¥é¥¹¤Î¥á¥½¥Ã¥É¤¬¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î
¥á¥½¥Ã¥É¤ò¼ÂÁõ¤·¤Æ¤¤¤ë¾ì¹ç) ¤Ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¼ÂÁõ¤·¤Æ¤¤¤ë
¥á¥½¥Ã¥É¤Î¥É¥­¥å¥á¥ó¥ÈÆâ¤Ë¡ÖÄêµÁ¡×¤È¤¤¤¦¾®¸«½Ð¤·¤òÀ¸À®¤·¡¢¥³¥á¥ó¥È¤¬·Ñ¾µ¤µ¤ì¤Æ¤¤¤ë¤«¤É¤¦¤«¤Ë¤«¤«¤ï¤é¤º¡¢
¼ÂÁõ¤µ¤ì¤Æ¤¤¤ë¥á¥½¥Ã¥É¤Ø¤Î¥ê¥ó¥¯¤ò½ñ¤­¹þ¤ß¤Þ¤¹¡£
.LP
¥á¥½¥Ã¥É¤ÎÀâÌÀ¤¬·Ñ¾µ¤µ¤ì¤ë¥¢¥ë¥´¥ê¥º¥à - ¤¢¤ë¥á¥½¥Ã¥É¤Ë
¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤¬µ­½Ò¤µ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢¤Þ¤¿¤Ï {@inheritDoc} ¥¿¥°¤¬¤¢¤ë¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ê¥¢¥ë¥´¥ê¥º¥à¤ò»ÈÍѤ·¤ÆŬÀڤʥ³¥á¥ó¥È¤ò¸¡º÷¤·¤Þ¤¹¡£
¤³¤Î¥¢¥ë¥´¥ê¥º¥à¤Ï¡¢¤â¤Ã¤È¤âŬÀڤʥɥ­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò
¸¡º÷¤Ç¤­¤ë¤è¤¦¤ËÀ߷פµ¤ì¤Æ¤ª¤ê¡¢¥¹¡¼¥Ñ¡¼¥¯¥é¥¹¤è¤ê¤â
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤¬Í¥À褵¤ì¤ë¤è¤¦¤Ë¤Ê¤Ã¤Æ¤¤¤Þ¤¹¡£
.TP 4
1.
ľÀܤ˼ÂÁõ¤µ¤ì¤Æ¤¤¤ë (¤Þ¤¿¤Ï¡¢³ÈÄ¥¤µ¤ì¤Æ¤¤¤ë) ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤ò¡¢
¥á¥½¥Ã¥É¤ÎÀë¸À¤Ç implements (¤Þ¤¿¤Ï extends) ¥­¡¼¥ï¡¼¥É¤Î¤¢¤È¤Ë
Åо줹¤ë½ç½ø¤Ç¡¢1 ¤Ä¤º¤ÄÄ´¤Ù¤ë¡£ ¤³¤Î¥á¥½¥Ã¥É¤Ë¤Ä¤¤¤Æ
ºÇ½é¤Ë¸«¤Ä¤«¤Ã¤¿¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤òºÎÍѤ¹¤ë
.TP 4
2.
¼ê½ç 1 ¤Ç¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¾ì¹ç¤Ï¡¢
ľÀܼÂÁõ¤µ¤ì¤Æ¤¤¤ë (¤Þ¤¿¤Ï¡¢³ÈÄ¥¤µ¤ì¤Æ¤¤¤ë) ¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î
¤½¤ì¤¾¤ì¤ËÂФ·¤Æ¡¢¤³¤Î¥¢¥ë¥´¥ê¥º¥àÁ´ÂΤòºÆµ¢Åª¤ËŬÍѤ¹¤ë (¤½¤ÎºÝ¤Î½ç½ø¤Ï¡¢¼ê½ç 1 ¤Ç¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤òÄ´¤Ù¤¿¤È¤­¤Î½ç½ø¤ÈƱ¤¸)
.TP 4
3.
¼ê½ç 2 ¤Ç¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¾ì¹ç¤Ç¡¢
¤³¤Î¥¯¥é¥¹¤¬ Object °Ê³°¤Î¥¯¥é¥¹¤Ç¤¢¤ë (¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ç¤Ï¤Ê¤¤) ¾ì¹ç¤Ï¡¢
¼¡¤Î¤è¤¦¤Ë½èÍý¤¹¤ë
.sp 1n
.nf
.ft 3
a. ¥¹¡¼¥Ñ¡¼¥¯¥é¥¹¤Ë¤³¤Î¥á¥½¥Ã¥É¤Ë¤Ä¤¤¤Æ¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤¬µ­½Ò¤µ¤ì¤Æ¤¤¤ì¤Ð¡¢¤½¤Î¥³¥á¥ó¥È¤òºÎÍѤ¹¤ë
b. ¼ê½ç 3a ¤Ç¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤¬¸«¤Ä¤«¤é¤Ê¤«¤Ã¤¿¾ì¹ç¤Ï¡¢¥¹¡¼¥Ñ¡¼¥¯¥é¥¹¤ËÂФ·¤Æ¡¢¤³¤Î¥¢¥ë¥´¥ê¥º¥àÁ´ÂΤòŬÍѤ¹¤ë
.ft 1
.fi
.LP
.SS "javadoc ¤Î¥¿¥°"
.LP
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢
.B java doc
¥³¥á¥ó¥ÈÆâ¤ËËä¤á¹þ¤Þ¤ì¤¿Æüì¤Ê¥¿¥°¤ò²òÀϤ·¤Þ¤¹¡£¤³¤ì¤é¤Î
Æüì¤Ê doc ¥¿¥°¤ò»È¤¦¤È¡¢
½ñ¼°¤ÎÀ°¤Ã¤¿´°Á´¤Ê API ¥É¥­¥å¥á¥ó¥È¤ò¥½¡¼¥¹
¥³¡¼¥É¤«¤é¼«Æ°Åª¤ËÀ¸À®¤Ç¤­¤Þ¤¹¡£
¥¿¥°¤Ï¡¢Ã±²Áµ­¹æ (\f3@\f1) ¤Ç»Ï¤Þ¤ê¡¢Âçʸ»ú¾®Ê¸»ú¤¬
¶èÊ̤µ¤ì¤Þ¤¹¡£¤³¤ì¤é¤Î¥¿¥°¤Ï¡¢
°Ê²¼¤Ë¼¨¤¹¤È¤ª¤ê¤Ë¡¢Âçʸ»ú¤È¾®Ê¸»ú¤ò¶èÊ̤·¤ÆÆþÎϤ¹¤ë
ɬÍפ¬¤¢¤ê¤Þ¤¹¡£¥¿¥°¤Ï¡¢¹Ô
¤ÎÀèƬ (¤¿¤À¤·Àè¹Ô¤¹¤ë¶õÇò¤È¾Êά²Äǽ¤Ê¥¢¥¹¥¿¥ê¥¹¥¯¤Ï½ü¤¯) ¤«¤é
»Ï¤á¤Ê¤±¤ì¤Ð¤Ê¤ê
¤Þ¤»¤ó¡£´·½¬¾å¡¢Æ±¤¸Ì¾Á°¤Î¥¿¥°¤Ï 1 ¸Ä½ê¤Ë¤Þ¤È¤á¤Æµ­½Ò¤·¤Þ¤¹¡£
¤¿¤È¤¨¤Ð¡¢
.B @see
¥¿¥°¤¬Ê£¿ô¤¢¤ë¾ì¹ç¤Ï¡¢¤¹¤Ù¤Æ¤ò 1 ¸Ä½ê¤Ë¤Þ¤È¤á¤Æµ­½Ò¤·¤Þ¤¹¡£
.LP
¥¿¥°¤Ï¼¡¤Î 2 ¼ïÎढ¤ê¤Þ¤¹¡£
.LP
\(bu
¥¹¥¿¥ó¥É¥¢¥í¥ó¥¿¥° - ÀâÌÀ¤Î¤¢¤È¤Î¥¿¥°¥»¥¯¥·¥ç¥ó¤À¤±¤Ë
ÃÖ¤¯¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£ ¤³¤Î¥¿¥°¤Ï¡¢@tag ¤Î¤è¤¦¤ËÃæ³ç¸Ì¤Ç°Ï¤ß¤Þ¤»¤ó¡£
.LP
\(bu
¥¤¥ó¥é¥¤¥ó¥¿¥° - ¥³¥á¥ó¥È¤ÎÀâÌÀÆâ¤Þ¤¿¤Ï¥¹¥¿¥ó¥É¥¢¥í¥ó¥¿¥°¤Î
¥³¥á¥ó¥ÈÃæ¤ÎǤ°Õ¤Î¾ì½ê¤ËÃÖ¤¯¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£ ¥¤¥ó¥é¥¤¥ó¥¿¥°¤Ï¡¢{@tag} ¤Î
¤è¤¦¤ËÃæ³ç¸Ì¤Ç°Ï¤ß¤Þ¤¹¡£
.LP
º£¸å¤Î¥ê¥ê¡¼¥¹¤ÇƳÆþ¤µ¤ì¤ë¥¿¥°¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/proposed\-tags.html
¤Î
.na
¡Ö\f2Proposed Tags\fP¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.LP
¸½»þÅÀ¤ÇÍ­¸ú¤Ê¥¿¥°¤Ï¡¢¼¡¤Î¤È¤ª¤ê¤Ç¤¹¡£
.LP
.RS 3
.LP
.LP
.TS
center;
cbp-1 cbp-1
l l.
¥¿¥° ƳÆþ¤µ¤ì¤¿ JDK/SDK ¤Î¥Ð¡¼¥¸¥ç¥ó
@author 1.0
{@code} 1.5
{@docRoot} 1.3
@deprecated} 1.0
@exception 1.0
{@inheritDoc} 1.4
{@link} 1.2
{@linkplain} 1.4
{@literal} 1.5
@param 1.0
@return 1.0
@see 1.0
@serial 1.2
@serialData 1.2
@serialField 1.2
@since 1.1
@throws 1.2
{@value} 1.4
@version 1.0
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-42
.LP
.LP
¥«¥¹¥¿¥à¥¿¥°¤Ë¤Ä¤¤¤Æ¤Ï¡¢\-tag ¥ª¥×¥·¥ç¥ó¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP
.BI @author " name-text"
.B \-author
¥ª¥×¥·¥ç¥ó¤¬»È¤ï¤ì¤Æ¤¤¤ë¾ì¹ç¡¢
À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤Ë¡¢»ØÄꤵ¤ì¤¿
name-text ¤ò»ý¤Ä Author ¥¨¥ó¥È¥ê¤òÄɲä·¤Þ¤¹¡£
1 ¤Ä¤Î doc ¥³¥á¥ó¥È¤ËÊ£¿ô¤Î
.B @author
¥¿¥°¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.B @author
¥¿¥°¤´¤È¤Ë 1 ¤Ä¡¢¤Þ¤¿¤Ï¥¿¥°¤´¤È¤ËÊ£¿ô¤Î̾Á°¤ò
»ØÄê¤Ç¤­¤Þ¤¹¡£Á°¼Ô¤Î¾ì¹ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢Ì¾Á°¤È̾Á°¤Î´Ö¤Ë¥³¥ó¥Þ (\f3,\f1) ¤È¥¹¥Ú¡¼¥¹¤òÁÞÆþ¤·¤Þ¤¹¡£
¸å¼Ô¤Î¾ì¹ç¡¢¥Æ¥­¥¹¥ÈÁ´ÂΤ¬
²òÀϤµ¤ì¤ë¤³¤È¤Ê¤¯À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤Ë¥³¥Ô¡¼¤µ¤ì¤ë¤À¤±¤Ç¤¹¡£
¤³¤Î¤¿¤á¡¢¥³¥ó¥Þ°Ê³°
¤Î¸½ÃÏ»ÅÍͤÎ̾Á°¶èÀÚ¤êʸ»ú¤ò»È¤¦¾ì¹ç¤Ï¡¢1 ¹Ô¤ËÊ£¿ô¤Î̾Á°¤ò»ØÄꤷ¤Þ¤¹¡£
.LP
¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢¡Ö¥¿¥°¤ò»ÈÍѤǤ­¤ë¾ì½ê¡×¤ª¤è¤Ó
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@author
¤Î
.na
\f2@author ¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È\fP¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.TP 3
@deprecated\ deprecated\-text
.RS 3
.LP
.LP
Ãí: JDK 5.0 ¤«¤é¡¢@Deprecated Ãí¼á¤ò»È¤Ã¤ÆÆÃÄê¤Î¥×¥í¥°¥é¥àÍ×ÁǤòÈó¿ä¾©¤Ë¤Ç¤­¤ë¤è¤¦¤Ë¤Ê¤ê¤Þ¤·¤¿¡£
.LP
¤³¤Î API ¤Ï (Æ°ºî¤Ï¤¹¤ë¤¬) »ÈÍѤ¹¤Ù¤­¤Ç¤Ê¤¤¤³¤È¤ò¼¨¤¹
¥³¥á¥ó¥È¤òÄɲä·¤Þ¤¹¡£
.B javadoc
¤Ï¡¢deprecated-text ¤òÀâÌÀ¤ÎÁ°¤Ë°ÜÆ°¤·¤Æ¥¤¥¿¥ê¥Ã¥¯¤Ë¤·¡¢
¤½¤ÎÁ°¤Ë¥Ü¡¼¥ë¥É¤Î·Ù¹ð
¡Ö¿ä¾©¤µ¤ì¤Þ¤»¤ó¡£¡×¤òÄɲä·¤Þ¤¹¡£¤³¤Î¥¿¥°¤Ï¤¹¤Ù¤Æ¤Î doc ¥³¥á¥ó¥È (³µÍס¢¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¥Õ¥£¡¼¥ë¥É) ¤ÇÍ­¸ú¤Ç¤¹¡£
.LP
.RS
deprecated-text ¤ÎºÇ½é¤Îʸ¤Ç¤Ï¡¢¾¯¤Ê¤¯¤È¤â¥æ¡¼¥¶¤Ë¤É¤Î¤è¤¦¤Ê¤È¤­¤Ë
¤½¤Î API ¤¬¿ä¾©¤µ¤ì¤Ê¤¤¤«¡¢¤ª¤è¤Ó¤½¤ì¤ËÂå¤ï¤ë API ¤òÄ󼨤¹¤ë
ɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.B javadoc
¤Ï¡¢ºÇ½é¤Îʸ¤À¤±¤òÍ×Ì󥻥¯¥·¥ç¥ó¤Èº÷°ú¤Ë¥³¥Ô¡¼¤·¤Þ¤¹¡£
¤¢¤È¤Ë³¤¯Ê¸¤Ç¡¢¤Ê¤¼¤½¤Î API ¤¬¿ä¾©¤µ¤ì¤Ê¤¤¤«¤ò
ÀâÌÀ¤¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£Âå¤ï¤ê¤Î API ¤ò
»Ø¤·¼¨¤¹ {\f3@link\f1} ¥¿¥° (
.B javadoc
1.2 °Ê¹ß¤Î¾ì¹ç) ¤ò´Þ¤á¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.LP
¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@deprecated
¤Î
.na
\f2@deprecated ¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È\fP¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.TP 2
\(bu
.B javadoc
1.2 °Ê¹ß¤Ç¤Ï¡¢{\f3@link\f1} ¥¿¥°¤ò»ÈÍѤ·¤Æ¤¯¤À¤µ¤¤¡£¤³¤ì¤Ë¤è¤ê¡¢
ɬÍפʾì½ê¤Ë¥¤¥ó¥é¥¤¥ó¤Ç
¥ê¥ó¥¯¤¬ºîÀ®¤µ¤ì¤Þ¤¹¡£¤¿¤È¤¨¤Ð¡¢¼¡¤Î¤è¤¦¤Ë»È¤¤¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
/**
* @deprecated As of JDK 1.1, replaced by
* {@link #setBounds(int,int,int,int)}
*/
.fi
.ft 1
.RE
.LP
.TP 2
\(bu
.B javadoc
1.1 ¤Ç¤Ï¡¢³Æ
.B @deprecated
¥¿¥°¤Ë
.B @see
¥¿¥° (¥¤¥ó¥é¥¤¥ó¤Ë¤Ç¤­¤Ê¤¤) ¤òºîÀ®¤¹¤ë¤Î¤¬É¸½à¤Î·Á¼°¤Ç¤¹¡£
.LP
¿ä¾©¤µ¤ì¤Ê¤¤¥¿¥°¤Ë¤Ä¤¤¤Æ¤Î¾ÜºÙ¤Ï¡¢¡Ö
.B @deprecated
¥¿¥°¡× ¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.RE
.TP
.B {@code text}
<code>{@literal}</code> ¤ÈƱÅù¤Ç¤¹¡£
.LP
¥Æ¥­¥¹¥È¤ò HTML ¥Þ¡¼¥¯¥¢¥Ã¥×¤Þ¤¿¤Ï
Æþ¤ì»Ò¤Ë¤Ê¤Ã¤¿ javadoc ¥¿¥°¤È¤·¤Æ²ò¼á¤»¤º¤Ë¡¢
¥Æ¥­¥¹¥È¤ò¥³¡¼¥É¥Õ¥©¥ó¥È¤Çɽ¼¨¤·¤Þ¤¹¡£
¤³¤ì¤Ë¤è¤ê doc ¥³¥á¥ó¥È¤Ç¤Ï¡¢
¥Ñ¥é¥á¡¼¥¿¤Î¼ïÎà ( <Object> )¡¢ÉÔÅù¹æ ( 3 < 4 )¡¢
¤Þ¤¿¤ÏÌð°õ ( <- ) ¤Ê¤É¤Ç¡¢HTML ¥¨¥ó¥Æ¥£¥Æ¥£ ( &lt; ¤ª¤è¤Ó &gt; ) ¤Ç¤Ï¤Ê¤¯¡¢
Ä̾ï¤Î»³³ç¸Ì (< ¤ª¤è¤Ó >) ¤ò»ÈÍѤǤ­¤Þ¤¹¡£
¤¿¤È¤¨¤Ð doc ¥³¥á¥ó¥È¤Î¥Æ¥­¥¹¥È
.LP
.RS 5
{@code A<B>C}
.RE
.LP
¤Ï¡¢À¸À®¤µ¤ì¤¿ HTML ¥Ú¡¼¥¸¤Ç¡¢¼¡¤Î¤è¤¦¤Ë¤½¤Î¤Þ¤Þɽ¼¨¤µ¤ì¤Þ¤¹¡£
.LP
.RS 5
A<B>C
.RE
.LP
ÃíÌܤ¹¤Ù¤­ÅÀ¤È¤·¤Æ¡¢<B> ¤ÏÂÀ»ú¤Ç¤¢¤ë¤È²ò¼á¤µ¤ì¤Þ¤»¤ó¤¬¡¢
¥³¡¼¥É¥Õ¥©¥ó¥È¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
¥³¡¼¥É¥Õ¥©¥ó¥È¤Ê¤·¤ÇƱ¤¸µ¡Ç½¤ò¼Â¸½¤¹¤ë¤Ë¤Ï¡¢
{@literal} ¤ò»ÈÍѤ·¤Þ¤¹¡£
.RE
.TP
.B {@docRoot}
À¸À®¤µ¤ì¤¿Ç¤°Õ¤Î¥Ú¡¼¥¸¤òµ¯ÅÀ¤È¤·¤¿¡¢¥É¥­¥å¥á¥ó¥È¤Î (½ÐÎÏÀè)
¥ë¡¼¥È¥Ç¥£¥ì¥¯¥È¥ê¤ÎÁêÂХѥ¹¤òɽ¤·¤Þ¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢Ãøºî¸¢¥Ú¡¼¥¸
¤Þ¤¿¤Ï²ñ¼Ò¤Î¥í¥´¤Ê¤É¡¢À¸À®¤µ¤ì¤ë¤¹¤Ù¤Æ¤Î¥Ú¡¼¥¸¤«¤é»²¾È¤¹¤ë¥Õ¥¡¥¤¥ë
¤ò¼è¤ê¹þ¤à¤È¤­¤Ë»È¤¤¤Þ¤¹¡£Ä̾ï¤Ï¡¢³Æ¥Ú¡¼¥¸¤ÎºÇ²¼Éô¤«¤éÃøºî¸¢
¥Ú¡¼¥¸¤Ë¥ê¥ó¥¯¤·¤Þ¤¹¡£
.RS
.LP
¤³¤Î \f2{@docRoot}\fP ¥¿¥°¤Ï¡¢¥³¥Þ¥ó¥É¹Ô¤«¤é¤â¡¢¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ÎÃæ¤Ç¤â»ÈÍѤǤ­¤Þ¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢@return¡¢@param¡¢@deprecated ¤Ê¤É¤ÎǤ°Õ¤Î¥¿¥°¤Î¥Æ¥­¥¹¥ÈÉôʬ¤ò´Þ¤à¡¢¤¹¤Ù¤Æ¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¡¢¤Ä¤Þ¤ê³µÍס¢¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¤ª¤è¤Ó¥Õ¥£¡¼¥ë¥É¤ÇÍ­¸ú¤Ç¤¹¡£
.TP 4
1.
¥³¥Þ¥ó¥É¹Ô¤Ç¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¥Ø¥Ã¥À (header)¡¢¥Õ¥Ã¥¿ (footer)¡¢
¤Þ¤¿¤Ï¥Ú¡¼¥¸¤ÎºÇ²¼Éô (bottom)¤òÄêµÁ¤·¤Þ¤¹¡£
.sp 1n
.B javadoc \-bottom '<a href="{@docRoot}/copyright.html">Copyright</a>'
.LP
Ãí - Makefile ¤ÎÃæ¤Ç {\f3@docRoot\f1}¤ò¤³¤Î¤è¤¦¤ËÍøÍѤ¹¤ë¾ì¹ç¡¢
°ìÉô¤Î Makefile ¥×¥í¥°¥é¥à¤Ç¤Ï¡¢Ãæ³ç¸Ì { } ʸ»ú¤ò¥¨¥¹¥±¡¼¥×¤¹¤ë
ɬÍפ¬¤¢¤ê¤Þ¤¹¡£ ¤¿¤È¤¨¤Ð¡¢Inprise MAKE ¥Ð¡¼¥¸¥ç¥ó 5.2 ¤ò
Windows ¾å¤Ç¼Â¹Ô¤¹¤ë¾ì¹ç¤Ï¡¢{{\f3@docRoot\f1}} ¤Î¤è¤¦¤Ë¡¢
Ãæ³ç¸Ì¤òÆó½Å¤Ë¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£¤µ¤é¤Ë¡¢\-bottom ¤Ê¤É¤Î
¥ª¥×¥·¥ç¥ó¤ËÂФ¹¤ë°ú¿ô¤ò¡¢Ã±°ì°úÍÑÉä¤Ç¤Ï¤Ê¤¯¡¢
Æó½Å°úÍÑÉä¤Ç°Ï¤àɬÍפ¬¤¢¤ê¤Þ¤¹¡£href
°ú¿ô¤ÎÃͤò°Ï¤à°úÍÑÉä¤Ï¾Êά¤·¤Þ¤¹¡£
.TP
2.
doc ¥³¥á¥ó¥È¤Ë¤Ï¼¡¤Î¤è¤¦¤Ëµ­½Ò¤·¤Þ¤¹¡£
.sp 1n
.nf
.ft 3
/**
* See the <a href="{@docRoot}/copyright.html">Copyright</a>.
*/
.ft 1
.fi
.LP
¤³¤Î¥¿¥°¤¬É¬ÍפÊÍýͳ¤Ï¡¢À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤¬¡¢¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤È
Ʊ¤¸³¬ÁؤΥǥ£¥ì¥¯¥È¥ê¤Ë³ÊǼ¤µ¤ì¤ë¤¿¤á¤Ç¤¹¡£¤¿¤È¤¨¤Ð¡¢¼¡¤Î¤è¤¦¤Ë»ØÄꤷ¤Þ¤¹¡£
.LP
.ti +5n
.B <a href="{@docRoot}/copyright.html">
.LP
¼¡¤Î¤è¤¦¤Ë²ò·è¤µ¤ì¤Þ¤¹¡£
.LP
.ti +5n
\f3<a href=".\|.\|/.\|.\|/copyright.html">\f1 .\|.\|. java/lang/Object.java ¤Î¾ì¹ç
.sp 1n
¤ª¤è¤Ó
.sp 1n
.ti +5n
\f3<a href=".\|.\|/.\|.\|/.\|.\|/copyright.html">\f1 .\|.\|. java/lang/ref/Reference.java ¤Î¾ì¹ç
.RE
.TP
.BI @exception " class-name description"
.B @exception
¥¿¥°¤Ï¡¢
.BR @throws
¤ÈƱµÁ¤Ç¤¹¡£
.TP
{\f3@inheritDoc\f1}
ºÇ¤â¶á¤¤¥¹¡¼¥Ñ¡¼¥¯¥é¥¹¤«¤é¸½ºß¤Î ¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ë¡¢¥É¥­¥å¥á¥ó¥È¤ò·Ñ¾µ¤·¤Þ¤¹¡£ ¤³¤Îµ¡Ç½¤Ë¤è¤ê¡¢¥³¥á¥ó¥È¤Ï·Ñ¾µ¥Ä¥ê¡¼¤Î¾å°Ì¤Ë°ÜÆ°¤·¡¢³«È¯¼Ô¤Ï¥³¥Ô¡¼¤·¤¿¥Æ¥­¥¹¥È¤Ëµ­½Ò¤òÄɲ乤뤳¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
¤³¤Î¥¿¥°¤Ï¡¢¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Î¼¡¤Î°ÌÃ֤ǤΤßÍ­¸ú¤Ç¤¹¡£
.RS 3
.TP 2
o
¥á¥½¥Ã¥É¤Î¼çÀâÌÀ¥Ö¥í¥Ã¥¯Æâ¡£¤³¤Î¾ì¹ç¡¢¼çÀâÌÀ¤Ï¡¢¾å°Ì³¬ÁؤΥ¯¥é¥¹¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤«¤é¥³¥Ô¡¼¤µ¤ì¤ë
.TP 2
o
¥á¥½¥Ã¥É¤Î @return¡¢@param¡¢@throws ¥¿¥°¤Î¥Æ¥­¥¹¥È°ú¿ôÆâ¡£¤³¤Î¾ì¹ç¡¢¥¿¥°¥Æ¥­¥¹¥È¤Ï¡¢¾å°Ì³¬ÁؤÎÂбþ¤¹¤ë¥¿¥°¤«¤é¥³¥Ô¡¼¤µ¤ì¤ë
.RE
.LP
·Ñ¾µ³¬Áؤǥ³¥á¥ó¥È¤ò¸«¤Ä¤±¤ëÊýË¡¤Ë´Ø¤¹¤ëÀµ³Î¤ÊÀâÌÀ¤Ë¤Ä¤¤¤Æ¡¢¡Ö¥á¥½¥Ã¥É¥³¥á¥ó¥È¤Î¼«Æ°¥³¥Ô¡¼¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£¤³¤Î¥¿¥°¤¬¸«¤Ä¤«¤é¤Ê¤¤¾ì¹ç¡¢¥³¥á¥ó¥È¤Ï¡¢¤³¤ÎÀá¤ÇÀâÌÀ¤¹¤ë¥ë¡¼¥ë¤Ë±þ¤¸¤Æ¡¢¼«Æ°Åª¤Ë·Ñ¾µ¤µ¤ì¤ë¤«¤É¤¦¤«¤¬·è¤Þ¤ê¤Þ¤¹¡£
.LP
.TP 3
{@link\ package.class#member\ label}
ɽ¼¨¥Æ¥­¥¹¥È label ¤È¤Î¥¤¥ó¥é¥¤¥ó¥ê¥ó¥¯¤òÁÞÆþ¤·¤Þ¤¹¡£\f2label\fP ¤Ï¡¢»²¾È¥¯¥é¥¹¤Î»ØÄꤵ¤ì¤¿¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¤Þ¤¿¤Ï¥á¥ó¥Ð¤Î̾Á°¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¤ò»Ø¤·¼¨¤·¤Þ¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢@return¡¢@param¡¢@deprecated ¤Ê¤É¤ÎǤ°Õ¤Î¥¿¥°¤Î¥Æ¥­¥¹¥ÈÉôʬ¤ò´Þ¤à¡¢¤¹¤Ù¤Æ¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¡¢¤Ä¤Þ¤ê³µÍס¢¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¤ª¤è¤Ó¥Õ¥£¡¼¥ë¥É¤ÇÍ­¸ú¤Ç¤¹¡£
.LP
¤³¤Î¥¿¥°¤Ï¡¢
.B @see
¥¿¥°¤È¤è¤¯»÷¤Æ¤¤¤Þ¤¹¡£¤É¤Á¤é¤Î¥¿¥°¤â¡¢package.class#member ¤ª¤è¤Ó
.BI label
¤Î»²¾È¤Î»ÅÊý¤¬Æ±¤¸¤Ç¡¢Í­¸ú¤Ê¹½Ê¸¤â¤Þ¤Ã¤¿¤¯Æ±¤¸¤Ç¤¹¡£
Â礭¤Ê°ã¤¤¤Ï¡¢{\f3@link\f1} ¤Ï¡¢¥ê¥ó¥¯¤ò [´ØÏ¢¹àÌÜ] ¥»¥¯¥·¥ç¥ó¤Ë
ÃÖ¤¯¤Î¤Ç¤Ï¤Ê¤¯¡¢¥¤¥ó¥é¥¤¥ó¥ê¥ó¥¯¤òÀ¸À®¤¹¤ë¤È¤¤¤¦¤³¤È¤Ç¤¹¡£
¤Þ¤¿¡¢¥¤¥ó¥é¥¤¥ó¥Æ¥­¥¹¥È¤Î¤Û¤«¤ÎÉôʬ¤È¶èÊ̤¹¤ë¤¿¤á¤Ë¡¢
{\f3@link\f1} ¥¿¥°¤ÎºÇ½é¤ÈºÇ¸å¤ËÃæ³ç¸Ì¤òµ­½Ò¤·¤Þ¤¹¡£
¥é¥Ù¥ë¤ÎÃæ¤Ç¡Ö}¡×¤ò»È¤¦É¬Íפ¬¤¢¤ë¾ì¹ç¤Ï¡¢HTML
¥¨¥ó¥Æ¥£¥Æ¥£¤Î¡Ö&#125;¡×¤ò»È¤¤¤Þ¤¹¡£
.LP
1 ¤Ä¤Îʸ¤ÎÃæ¤Ç»ÈÍѤǤ­¤ë {@link} ¥¿¥°¤Î¿ô¤ËÀ©¸Â¤Ï¤¢¤ê¤Þ¤»¤ó¡£
¤³¤Î¥¿¥°¤Ï¡¢¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ÎÀâÌÀÉôʬ¡¢¤Þ¤¿¤Ï
.BR @deprecated
¡¢
.BR @return
¡¢
.BR @param
¤Ê¤É¤ÎǤ°Õ¤Î¥¿¥°¤Î¥Æ¥­¥¹¥ÈÉôʬ¤Ç»È¤¦¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
¤¿¤È¤¨¤Ð¡¢¼¡¤Î¥³¥á¥ó¥È¤Ç¤Ï¡¢
.B getComponentAt(int, int)
¥á¥½¥Ã¥É¤ò»²¾È¤·¤Æ¤¤¤Þ¤¹¡£
.LP
.ft 3
.nf
Use the {\f3@link #getComponentAt(int, int) getComponentAt\f1} method.
.fi
.ft 1
.LP
ɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤Ç¤Ï¡¢¾åµ­¤Î¥³¥á¥ó¥È¤«¤é¼¡¤Î HTML ¤¬
À¸À®¤µ¤ì¤Þ¤¹ (¤³¤Î¥³¥á¥ó¥È¤¬Æ±¤¸¥Ñ¥Ã¥±¡¼¥¸¤ÎÊ̤Υ¯¥é¥¹¤ò»²¾È¤·¤Æ¤¤¤ë¾ì¹ç)¡£
.LP
.ft 3
.nf
Use the
<a href="Component.html#getComponentAt(int, int)">getComponentAt</a>method.
.fi
.ft 1
.LP
¤³¤Î HTML ¤Ï¡¢Web ¥Ú¡¼¥¸¾å¤Ç¤Ï¼¡¤Î¤è¤¦¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£
.LP
.ft 3
.nf
Use the getComponentAt method.
.fi
.ft 1
.LP
{\f3@link\f1} ¤ò¡¢¥É¥­¥å¥á¥ó¥È²½¤ÎÂоݤˤ·¤Æ¤¤¤Ê¤¤¥¯¥é¥¹¤Ë¤Þ¤Ç
³ÈÄ¥¤¹¤ë¤Ë¤Ï¡¢
.BR \-link
¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Þ¤¹¡£
.LP
¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#{@link}
¤Î
.na
\f2{@link} ¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È\fP¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.RE
.TP
{@linkplain package.class#member label}
¥ê¥ó¥¯¤Î¥é¥Ù¥ë¤¬¥³¡¼¥É¥Õ¥©¥ó¥È¤Ç¤Ï¤Ê¤¯¥×¥ì¡¼¥ó¥Æ¥­¥¹¥È¤Ç
ɽ¼¨¤µ¤ì¤Æ¤¤¤ëÅÀ°Ê³°¤Ï¡¢
{\f3@link\f1} ¤ÈƱ¤¸¤Ç¤¹¡£ ¥é¥Ù¥ë¤¬¥×¥ì¡¼¥ó¥Æ¥­¥¹¥È¤Ç
µ­½Ò¤µ¤ì¤Æ¤¤¤ë¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£¼¡¤ÎÎã¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.ft 3
.nf
Refer to {\f3@linkplain\f1 add() the overridden method}.
.fi
.ft 1
.LP
¤³¤ì¤Ï°Ê²¼¤Î¤è¤¦¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£
.LP
.ft 3
.nf
Refer to the overridden method.
.fi
.ft 1
.LP
.TP
.B {@literal text}
¥Æ¥­¥¹¥È¤ò HTML ¥Þ¡¼¥¯¥¢¥Ã¥×¤Þ¤¿¤Ï
Æþ¤ì»Ò¤Ë¤Ê¤Ã¤¿ javadoc ¥¿¥°¤È¤·¤Æ²ò¼á¤»¤º¤Ë¡¢
¥Æ¥­¥¹¥È¤ò¥³¡¼¥É¥Õ¥©¥ó¥È¤Çɽ¼¨¤·¤Þ¤¹¡£
¤³¤ì¤Ë¤è¤ê doc ¥³¥á¥ó¥È¤Ç¤Ï¡¢
¥Ñ¥é¥á¡¼¥¿¤Î¼ïÎà ( <Object> )¡¢ÉÔÅù¹æ ( 3 < 4 )¡¢
¤Þ¤¿¤ÏÌð°õ ( <- ) ¤Ê¤É¤Ç¡¢HTML ¥¨¥ó¥Æ¥£¥Æ¥£ ( &lt; ¤ª¤è¤Ó &gt; ) ¤Ç¤Ï¤Ê¤¯¡¢
Ä̾ï¤Î»³³ç¸Ì (< ¤ª¤è¤Ó >) ¤ò»ÈÍѤǤ­¤Þ¤¹¡£
¤¿¤È¤¨¤Ð doc ¥³¥á¥ó¥È¤Î¥Æ¥­¥¹¥È
.LP
.RS 5
{@literal A<B>C}
.RE
.LP
¤Ï¡¢À¸À®¤µ¤ì¤¿ HTML ¥Ú¡¼¥¸¤Ï¥Ö¥é¥¦¥¶¤Ç¼¡¤Î¤è¤¦¤Ë¤½¤Î¤Þ¤Þɽ¼¨¤µ¤ì¤Þ¤¹¡£
.LP
.RS 5
A<B>C
.RE
.LP
ÃíÌܤ¹¤Ù¤­ÅÀ¤È¤·¤Æ¡¢<B> ¤ÏÂÀ»ú¤Ç¤¢¤ë¤È²ò¼á¤µ¤ì¡¢
¥³¡¼¥É¥Õ¥©¥ó¥È¤Ë¤Ê¤ê¤Þ¤»¤ó¡£
.LP
¥³¡¼¥É¥Õ¥©¥ó¥È¤ÇƱ¤¸µ¡Ç½¤ò¼Â¸½¤¹¤ë¤Ë¤Ï¡¢
{@code} ¤ò»ÈÍѤ·¤Þ¤¹¡£
.TP
.BI @param " parameter-name description"
»ØÄꤷ¤¿ parameter-name ¤È»ØÄꤷ¤¿ description ¤ò»ÈÍѤ·¤Æ
¥Ñ¥é¥á¡¼¥¿¤ò¡ÖParameters¡×¥»¥¯¥·¥ç¥ó¤ËÄɲä·¤Þ¤¹¡£
doc ¥³¥á¥ó¥È¤òµ­½Ò¤¹¤ë¤È¤­¤Ï¡¢description ¤òÊ£¿ô¹Ô¤Ë
³¤±¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢
¥á¥½¥Ã¥É¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¤Þ¤¿¤Ï¥¯¥é¥¹¤Î
doc ¥³¥á¥ó¥ÈÆâ¤Ç¤Î¤ßÍ­¸ú¤Ç¤¹¡£
.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
\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
\fP
.fi
¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@param
¤Î
.na
\f2@param ¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È\fP¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.TP 3
@return\ description
¡ÖÌá¤êÃ͡ץ»¥¯¥·¥ç¥ó¤òÄɲ䷤ơ¢\f2description\fP ¤Î¥Æ¥­¥¹¥È¤ò½ñ¤­¹þ¤ß¤Þ¤¹¡£¤³¤Î¥Æ¥­¥¹¥È¤Ç¤Ï¡¢Ìá¤êÃͤη¿¤È¡¢¼è¤êÆÀ¤ëÃͤÎÈϰϤˤĤ¤¤Æµ­½Ò¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢¥á¥½¥Ã¥É¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ç¤Î¤ßÍ­¸ú¤Ç¤¹¡£
.LP
¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@return
¤Î
.na
\f2@return ¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È\fP¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.TP 3
@see\ reference
¡Ö´ØÏ¢¹àÌܡ׸«½Ð¤·¤òÄɲä·¡¢\f2reference\fP ¤ò»Ø¤¹¥ê¥ó¥¯¤«¡¢¤Þ¤¿¤Ï¥Æ¥­¥¹¥È¥¨¥ó¥È¥ê¤ò½ñ¤­¹þ¤ß¤Þ¤¹¡£1 ¤Ä¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ë¤Ï¡¢Ç¤°Õ¤Î¿ô¤Î \f2@see\fP ¥¿¥°¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£¤¹¤Ù¤Æ¤Î \f2@see\fP ¥¿¥°¤ÎÆâÍƤϡ¢Æ±¤¸¸«½Ð¤·¤Î²¼¤Ë¥°¥ë¡¼¥×²½¤µ¤ì¤Þ¤¹¡£\f2@see\fP ¥¿¥°¤Ë¤Ï¡¢¼¡¤Î 3 ¼ïÎà¤Î·Á¼°¤¬¤¢¤ê¤Þ¤¹¡£¤â¤Ã¤È¤â¤è¤¯»È¤ï¤ì¤ë¤Î¤Ï¡¢3 ÈÖÌܤηÁ¼°¤Ç¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢¤¹¤Ù¤Æ¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¡¢¤Ä¤Þ¤ê³µÍס¢¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¤ª¤è¤Ó¥Õ¥£¡¼¥ë¥É¤ÇÍ­¸ú¤Ç¤¹¡£¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¤Þ¤¿¤Ï¥á¥ó¥Ð¤ËÂФ¹¤ë¥¤¥ó¥é¥¤¥ó¥ê¥ó¥¯¤òʸÃæ¤ËÁÞÆþ¤¹¤ëÊýË¡¤Ï¡¢\f2{@link}\fP ¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.RS 3
.TP 3
@see "string"
string ¤Î¥Æ¥­¥¹¥È¥¨¥ó¥È¥ê¤òÄɲä·¤Þ¤¹¡£
¥ê¥ó¥¯¤ÏÀ¸À®¤µ¤ì¤Þ¤»¤ó¡£string ¤Ï¡¢½ñÀÒ¡¢¤Þ¤¿¤Ï
URL ¤Ç¤Ï¥¢¥¯¥»¥¹¤Ç¤­¤Ê¤¤¾ðÊó¤Î»²¾ÈÀè¤Ç¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢ºÇ½é¤Îʸ»ú¤¬Æó½Å°úÍÑÉä (") ¤«¤É¤¦¤«¤òÄ´¤Ù¤Æ¡¢
¾å¤Î 2 ¤Ä¤Î·Á¼°¤È¤³¤Î·Á¼°¤È¤ò¶è
Ê̤·¤Þ¤¹¡£¼¡¤ËÎã¤ò¼¨¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
@see "The Java Programming Language"
.fi
.ft 1
.LP
¤³¤ì¤Ï¼¡¤Î¤è¤¦¤Ê¥Æ¥­¥¹¥È¤òÀ¸À®¤·¤Þ¤¹¡£
.LP
.ft 3
.nf
´ØÏ¢¹àÌÜ:
"The Java Programming Language"
.fi
.ft 1
.RE
.TP
\f3@see <a href="\f2URL#value\f3">\f2label\f3</a>\f1
.IR URL#value
¤ÇÄêµÁ¤µ¤ì¤¿¤È¤ª¤ê¤Ë¥ê¥ó¥¯¤òÄɲä·¤Þ¤¹¡£
.I URL#value
¤Ï¡¢ÁêÂÐ URL ¤Þ¤¿¤ÏÀäÂÐ URL ¤Ç¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢ºÇ½é¤Îʸ»ú¤È¤·¤Æ¡¢¾®¤Ê¤ê³ç¸Ì (\f3<\f1) ¤òõ¤¹¤³¤È¤Ç¡¢
¤³¤Î¥ê¥ó¥¯¤ò¤½¤Î¾¤Î¾ì¹ç¤È¶èÊ̤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
@see <a href="spec.html#section">Java Spec</a>
.fi
.ft 1
.LP
¤³¤ì¤Ï¼¡¤Î¤è¤¦¤Ê¥ê¥ó¥¯¤òÀ¸À®¤·¤Þ¤¹¡£
.LP
.ft 3
.nf
´ØÏ¢¹àÌÜ:
Java Spec
.fi
.ft 1
.RE
.TP
.BI @see " package.class#member label"
»²¾È¤µ¤ì¤ë Java ¸À¸ì¤Ç»ØÄꤵ¤ì¤¿Ì¾Á°¤Î¥É¥­¥å¥á¥ó¥È¤ò»Ø¤¹¡¢
ɽ¼¨¥Æ¥­¥¹¥È label ¤ò»ý¤Ä
¥ê¥ó¥¯¤òÄɲä·¤Þ¤¹¡£label ¤Ï¾Êά²Äǽ¤Ç¤¹¡£label ¤ò¾Êά¤·¤¿¾ì¹ç¤Ï¡¢
³ºÅö¤¹¤ë̾Á°¤¬
ŬÀÚ¤Ëû¤¯¤µ¤ì¤Æ (¡Ö̾Á°¤Îɽ¼¨ÊýË¡¡×¤ò»²¾È)¡¢
ɽ¼¨¥Æ¥­¥¹¥È¤È¤·¤ÆÂå¤ï¤ê¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£-noqualifier ¤ò»ÈÍѤ¹¤ë¤È¡¢É½¼¨¥Æ¥­¥¹¥È¤«¤é¥Ñ¥Ã¥±¡¼¥¸Ì¾¤¬Á´ÂÎŪ¤Ëºï½ü¤µ¤ì¤Þ¤¹¡£¥é¥Ù¥ë¤Ï¡¢¼«Æ°À¸À®¤µ¤ì¤ëɽ¼¨¥Æ¥­¥¹¥È¤È¤Ï°Û¤Ê¤ëɽ¼¨¥Æ¥­¥¹¥È¤ò»ØÄꤹ¤ë¾ì¹ç¤Ë»È¤¤¤Þ¤¹¡£
.LP
.RS
¥Ð¡¼¥¸¥ç¥ó 1.2 ¤Ç¤Ï¡¢¥é¥Ù¥ë¤Ç¤Ï¤Ê¤¯¡¢Ì¾Á°¤À¤±¤¬
HTML ¥¿¥°
.B <code>
¤Ë°Ï¤Þ¤ì¤Æ¼«Æ°Åª¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£¥Ð¡¼¥¸¥ç¥ó 1.2.2 °Ê¹ß¤Ï¡¢
.B <code>
¤Ï¾ï¤Ë¡¢¥é¥Ù¥ë¤¬»ÈÍѤµ¤ì¤Æ¤¤¤ë¤«¤É¤¦¤«¤Ë¤«¤«¤ï¤é¤º¡¢
ɽ¼¨²Äǽ¤Ê¥Æ¥­¥¹¥È¤ò°Ï¤ß¤Þ¤¹¡£
.TP 2
\(bu
.I package.class#member
¤Ë¤Ï¡¢Java ¸À¸ì¤ÇÍ­¸ú¤ÊǤ°Õ¤Î̾Á°¡¢¤Ä¤Þ¤ê¥Ñ¥Ã¥±¡¼¥¸¡¢
¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢
¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¤Þ¤¿¤Ï¥Õ¥£¡¼¥ë¥É¤Î̾Á°¤ò»ØÄꤷ¤Þ¤¹
¡£¤¿¤À¤·¡¢¥á¥ó¥Ð̾¤ÎÁ°¤Î
¥É¥Ã¥È¤Ï¡¢¥Ï¥Ã¥·¥åʸ»ú (#) ¤ÇÃÖ¤­´¹¤¨¤Þ¤¹¡£
»ØÄꤷ¤¿Ì¾Á°¤¬¡¢¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹
¤Ë¤¢¤ë¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï³ºÅö¤¹¤ë̾Á°¤Ø¤Î¥ê¥ó¥¯¤ò¼«Æ°Åª¤ËºîÀ®¤·¤Þ¤¹¡£
³°Éô»²¾È¥¯¥é¥¹¤Ø¤Î¥ê¥ó¥¯¤òºîÀ®¤¹¤ë
¤Ë¤Ï¡¢
.B \-link
¥ª¥×¥·¥ç¥ó¤ò»È¤¤¤Þ¤¹¡£»²¾È¤µ¤ì¤ë¥¯¥é¥¹¤Ë°¤·¤Æ¤¤¤Ê¤¤Ì¾Á°¤Î
¥É¥­¥å¥á¥ó¥È¤ò»²
¾È¤¹¤ë¤Ë¤Ï¡¢¤Û¤«¤Î 2 ¤Ä¤Î·Á¼°¤Î
.B @see
¥¿¥°¤ò»È¤¤¤Þ¤¹¡£1 ÈÖÌܤΰú¿ô¤Ë¤Ä¤¤¤Æ¤Ï¡¢¡Ö̾Á°¤Î»ØÄê¡× ¤Ç
¾Ü¤·¤¯ÀâÌÀ¤·¤Þ¤¹¡£
.TP 2
\(bu
.I label
¤Ï¾Êά²Äǽ¤Ê¥Æ¥­¥¹¥È¤Ç¡¢
¥ê¥ó¥¯¤Î¥é¥Ù¥ë¤È¤·¤Æɽ¼¨¤µ¤ì¤Þ¤¹¡£label ¤Ë¤Ï¶õÇò¤ò´Þ
¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£label ¤ò¾Êά¤·¤¿¾ì¹ç¤Ï¡¢
.I package.class.member
¤¬¡¢¸½ºß¤Î¥¯¥é¥¹¤ª¤è¤Ó¥Ñ¥Ã¥±¡¼¥¸¤Ë±þ¤¸¤Æ
ŬÀÚ¤Ëû¤¯¤µ¤ì¤Æɽ¼¨¤µ¤ì¤Þ¤¹¡£¡Ö̾Á°¤Îɽ¼¨ÊýË¡¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP 2
\(bu
¶õÇòʸ»ú¤Ï
.I package.class#member
¤È
.IR label
¤Î´Ö¤Î¶èÀÚ¤êʸ»ú¤Ç¤¹¡£³ç¸ÌÆâ¤Î¶õÇòʸ»ú¤Ï¡¢
¥é¥Ù¥ë¤Î³«»Ï¤ò°ÕÌ£¤·¤Ê¤¤¤¿¤á¡¢
¥á¥½¥Ã¥É¤Î¥Ñ¥é¥á¡¼¥¿´Ö¤Î¥Ç¥ê¥ß¥¿¤È¤·¤Æ»È¤¦¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
Îã-¤³¤ÎÎã¤Ç¤Ï¡¢Character ¥¯¥é¥¹¤Î
.B @see
¥¿¥°¤¬ String ¥¯¥é¥¹¤Î equals ¥á¥½¥Ã¥É¤ò»²¾È¤·¤Æ¤¤¤Þ¤¹¡£
¥¿¥°¤Ë¤Ï¡¢Ì¾Á° \f3String#equals(Object)\f1 ¤È¥é¥Ù¥ë \f3equals\f1 ¤Î
ξÊý¤Î°ú¿ô¤¬´Þ¤Þ¤ì¤Æ¤¤¤Þ¤¹¡£
.LP
.ft 3
.nf
/**
* @see String#equals(Object) equals
*/
.fi
.ft 1
.LP
ɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤Ï¡¢¼¡¤Î¤è¤¦¤Ê HTML ¤òÀ¸À®¤·¤Þ¤¹¡£
.LP
.ft 3
.nf
<dl>
<dt><b>´ØÏ¢¹àÌÜ:</b>
<dd><a href="../../java/lang/String#equals(java.lang.Object)"><code>equals</code></a>
</dl>
.fi
.ft 1
.LP
¤³¤ì¤Ï¡¢¥Ö¥é¥¦¥¶¤Ç¤Ï¼¡¤Î¤è¤¦¤Ëɽ¼¨¤µ¤ì¡¢
¥é¥Ù¥ë¤¬¥ê¥ó¥¯¥Æ¥­¥¹¥È¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
.ft 3
.nf
´ØÏ¢¹àÌÜ:
equals
.fi
.ft 1
.LP
.B ̾Á°¤Î»ØÄê:
¤³¤Î
.I package.class#member
¤Î̾Á°¤Ï¡¢
.BR java.lang.String#toUpperCase()
¤Î¤è¤¦¤Ë´°Á´»ØÄꤹ¤ë¤³¤È¤â¡¢
.B String#toUpperCase()
¤ä
.BR #toUpperCase()
¤Ê¤É¤Î¤è¤¦¤Ë´°Á´»ØÄꤷ¤Ê¤¤¤³¤È¤â²Äǽ¤Ç¤¹¡£
´°Á´»ØÄꤷ¤Ê¤¤¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢Ä̾ï¤Î Java ¥³¥ó¥Ñ¥¤¥é¤Î¸¡º÷½ç½ø¤Ç¸¡º÷¤ò¹Ô¤¤¤Þ¤¹¡£
¾ÜºÙ¤Ï¡¢°Ê²¼¤Î¡Ö
.BR @see
¤Î¸¡º÷½ç½ø¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£»ØÄꤹ¤ë̾Á°¤Ç¤Ï¡¢
¥á¥½¥Ã¥É¤ÎÊ£¿ô¤Î°ú¿ô¤Î·¿¤Î´Ö¤Ê¤É¡¢
³ç¸ÌÆâ¤Ë¶õÇò¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
û¤¤Éôʬ½¤¾þ̾¤ò»ØÄꤹ¤ë¤³¤È¤ÎÍøÅÀ¤Ï¡¢ÆþÎϤ¹¤ë
ʸ»ú¿ô¤¬¸º¤ë¤³¤È¤È¡¢¥½¡¼¥¹¥³¡¼¥É¤¬
Æɤߤ䤹¤¯¤Ê¤ë¤³¤È¤Ç¤¹¡£°Ê²¼¤Îɽ¤Ë¼¨¤¹¤Î¤Ï¡¢¤µ¤Þ¤¶¤Þ¤Ê
·Á¼°¤Î̾Á°¤Ç¤¹¡£Class ¤Ë¤Ï
¥¯¥é¥¹¤«¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢Type ¤Ë¤Ï¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢
ÇÛÎ󡢤ޤ¿¤Ï´ðËܥǡ¼¥¿·¿¡¢
method ¤Ë¤Ï¥á¥½¥Ã¥É¤Þ¤¿¤Ï¥³¥ó¥¹¥È¥é¥¯¥¿¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
.LP
.LP
.TS
box;
lp-1.
@see package.class#member ¤Î°ìÈÌŪ¤Ê·Á¼°
_
¸½ºß¤Î¥¯¥é¥¹¤Î¥á¥ó¥Ð¤ò»²¾È¤¹¤ë
@see #field
@see #method(Type, Type,...)
@see #method(Type argname, Type argname,...)
@see #constructor(Type, Type,...)
@see #constructor(Type argname, Type argname,...)
_
T{
¸½ºß¤Î¡¢¤Þ¤¿¤Ï¥¤¥ó¥Ý¡¼¥È¤µ¤ì¤¿¥Ñ¥Ã¥±¡¼¥¸¤ÎÊ̤Υ¯¥é¥¹¤ò»²¾È¤¹¤ë
T}
@see Class#field
@see Class#method(Type, Type,...)
@see Class#method(Type argname, Type argname,...)
@see Class#constructor(Type, Type,...)
T{
@see Class#constructor(Type argname, Type argname,...)
T}
@see Class.NestedClass
@see Class
_
Ê̤Υѥ屡¼¥¸¤ÎÍ×ÁǤò»²¾È¤¹¤ë (´°Á´½¤¾þ)
@see package.Class#field
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type argname, Type argname,...)
@see package.Class#constructor(Type, Type,...)
T{
@see package.Class#constructor(Type argname, Type argname,...)
T}
@see package.Class.NestedClass
@see package.Class
@see package
.TE
.LP
¾å¤Îɽ¤ËÂФ¹¤ëÃí¤ò°Ê²¼¤Ë¼¨¤·¤Þ¤¹¡£
.LP
.TP 2
\(bu
¥¯¥é¥¹¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸¤ò¾Ê¤¤¤¿ºÇ½é¤Î·Á¼°¤Î¥»¥Ã¥È¤Ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¸½ºß¤Î¥¯¥é¥¹³¬ÁؤÀ¤±¤Ç¸¡º÷¤ò¹Ô¤¤¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¸½ºß¤Î¥¯¥é¥¹¤«¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥á¥ó¥Ð¡¢¥¹¡¼¥Ñ¡¼¥¯¥é¥¹¤«
¥¹¡¼¥Ñ¡¼¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î 1 ¤Ä¡¢¤Þ¤¿¤Ï
¿Æ¥¯¥é¥¹¤«¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î 1 ¤Ä (¸¡º÷¼ê½ç 1 ¡Á 3) ¤ò¸¡º÷¤·¤Þ¤¹¡£
¸½ºß¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¤Û¤«¤ÎÉôʬ¤ä¤Û¤«¤Î¥Ñ¥Ã¥±¡¼¥¸ (¸¡º÷¼ê½ç 4 ¡Á 5) ¤Ï
¸¡º÷¤·¤Þ¤»¤ó¡£
.TP 2
\(bu
¥á¥½¥Ã¥É¤Þ¤¿¤Ï¥³¥ó¥¹¥È¥é¥¯¥¿¤¬¡¢getValue ¤Î¤è¤¦¤Ë
³ç¸Ì¤òÉÕ¤±¤º¤Ë̾Á°¤È¤·¤ÆÆþÎϤµ¤ì¡¢
¤«¤ÄƱ¤¸Ì¾Á°¤Î¥Õ¥£¡¼¥ë¥É¤¬¤Ê¤¤¾ì¹ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤ÏÀµ³Î¤Ë¥ê¥ó¥¯¤òºîÀ®¤·¤Þ¤¹¤¬¡¢³ç¸Ì¤È°ú¿ô¤òÄɲ乤ë¤è¤¦¤Ë
Â¥¤¹·Ù¹ð¥á¥Ã¥»¡¼¥¸¤ò½ÐÎÏ
¤·¤Þ¤¹¡£¤³¤Î¥á¥½¥Ã¥É¤ò¥ª¡¼¥Ð¡¼¥í¡¼¥É¤·¤¿¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢»ØÄꤵ¤ì¤¿¥á¥½¥Ã¥É¤Ç¤Ï¤Ê¤¯¡¢¸¡º÷¤Ç¸«¤Ä¤«¤Ã¤¿
ºÇ½é¤Î¥á¥½¥Ã¥É¤Ë¥ê¥ó¥¯¤·¤Þ¤¹¡£
.TP 2
\(bu
Æþ¤ì»Ò¤ÎÆâÉô¥¯¥é¥¹¤Ï¡¢¤É¤Î·Á¼°¤Î¾ì¹ç¤Ç¤â¡¢Ã±¤Ë
.BR inner
¤È¤¤¤¦·Á¤Ç¤Ï¤Ê¤¯¡¢
.BR outer.inner
¤È¤¤¤¦·Á¤Ç»ØÄꤷ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
.TP 2
\(bu
¤¹¤Ç¤Ë½Ò¤Ù¤¿¤È¤ª¤ê¡¢¥¯¥é¥¹¤È¥á¥ó¥Ð¤ò¶èÀÚ¤ë¤Î¤Ë¡¢¥É¥Ã¥È (\f3.\f1) ¤Ç¤Ï¤Ê¤¯
¥Ï¥Ã¥·¥åʸ»ú (\f3#\f1) ¤¬
»È¤ï¤ì¤Æ¤¤¤ë¤³¤È¤ËÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£¥É¥Ã¥È¤Ï¡¢¥¯¥é¥¹¡¢
Æþ¤ì»Ò¤Î¥¯¥é¥¹¡¢¥Ñ¥Ã¥±¡¼¥¸¡¢¤ª¤è¤Ó
¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤ò¶èÀÚ¤ë¤Î¤Ë¤â»È¤ï¤ì¤Þ¤¹¡£
¤¿¤À¤·¡¢
.B javadoc
¥Ä¡¼¥ë¤Ç¤Ï°ìÈ̤˵öÍÆÈϰϤ¬¹­¤¯¡¢
¤¢¤¤¤Þ¤¤¤µ¤¬¤Ê¤±¤ì¤Ð¡¢¥É¥Ã¥È¤Ç¤âÀµ¤·¤¯²òÀϤµ¤ì¤Þ¤¹¡£
¤½¤Î¾ì¹ç¤Ç¤â·Ù¹ð¤Ïɽ¼¨¤µ¤ì¤Þ¤¹¡£
.LP
.B @see ¤Î¸¡º÷½ç½ø:
.B javadoc
¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë (\f3.java\f1)¡¢¥Ñ¥Ã¥±¡¼¥¸
¥Õ¥¡¥¤¥ë (\f3package.html\f1 ¤« \f3package\-info.java\f1)¡¢¤Þ¤¿¤Ï
³µÍ×¥Õ¥¡¥¤¥ë (\f3overview.html\f1) Æâ¤Ç»È¤ï¤ì¤ë
.B @see
¥¿¥°¤ò½èÍý¤·¤Þ¤¹¡£
¤¢¤È¤Î 2 ¤Ä¤Î¥Õ¥¡¥¤¥ë¤Ç¤Ï¡¢
.BR @see
¤ò»È¤Ã¤Æ»ØÄꤹ¤ë̾Á°¤ò´°Á´½¤¾þ¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ç¤Ï¡¢´°Á´½¤¾þ̾
¤ÈÉôʬ½¤¾þ̾¤Î¤É¤Á¤é¤ò»ØÄꤹ¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
.LP
.B javadoc
¥Ä¡¼¥ë¤¬¡¢´°Á´½¤¾þ¤µ¤ì¤Æ¤¤¤Ê¤¤
.B .java
¥Õ¥¡¥¤¥ë¤Ç
.B @see
¥¿¥°¤ò¸«¤Ä¤±¤¿¾ì¹ç¡¢»ØÄꤵ¤ì¤¿Ì¾Á°¤ò Java ¥³¥ó¥Ñ¥¤¥é¤È
Ʊ¤¸½ç½ø¤Ç¸¡º÷¤·¤Þ¤¹¡£¤¿¤À¤·¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢°ìÉô¤Î̾Á°¶õ´Ö¤Î¤¢¤¤¤Þ¤¤¤µ¤Ï¸¡½Ð¤·¤Þ¤»¤ó¡£¤³¤ì¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤¬¡¢¥½¡¼¥¹¥³¡¼¥É¤Ë¤³¤ì¤é¤Î¥¨¥é¡¼¤¬Â¸ºß¤·¤Æ¤¤¤Ê¤¤¤³¤È¤ò
Á°Äó¤È¤·¤ÆÆ°ºî¤¹¤ë¤¿¤á¤Ç¤¹¡£
¸¡º÷½ç½ø¤Ï¡¢¡ÖJava Language Specification¡×Âè 2 ÈǤÎÂè 6 ¾Ï¡ÖNames¡×¤Ç
Àµ¼°¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤Þ¤¹¡£¶ñÂÎŪ¤Ë¤Ï¡¢¸¡º÷¤Ï¼¡¤Î½ç½ø¤Ç¹Ô¤ï¤ì¤Þ¤¹¡£
.LP
.TP 4
1.
¸½ºß¤Î¥¯¥é¥¹¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹
.PD 0
.TP 4
2.
̾Á°¤ò°Ï¤à¥¯¥é¥¹¤È¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡£¤â¤Ã¤È¤â¶á¤¤¤â¤Î¤òºÇ½é¤Ë¸¡º÷
.TP 4
3.
¥¹¡¼¥Ñ¡¼¥¯¥é¥¹¤È¥¹¡¼¥Ñ¡¼¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡£¤â¤Ã¤È¤â¶á¤¤¤â¤Î¤òºÇ½é¤Ë¸¡º÷
.TP 4
4.
¸½ºß¤Î¥Ñ¥Ã¥±¡¼¥¸
.TP 4
5.
¥¤¥ó¥Ý¡¼¥È¤µ¤ì¤ë¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢
¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡£import ʸ¤Î½ç½ø¤Ë½¾¤Ã¤Æ¸¡º÷
.PD
.LP
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢°ìÃפ¹¤ë̾Á°¤¬¸«¤Ä¤«¤ë¤Þ¤Ç¡¢³Æ¥¯¥é¥¹¤Ë¤Ä¤¤¤Æ
¼ê½ç 1 ¡Á 3 ¤ò·«¤êÊÖ¤·¤Æ¸¡º÷¤ò³¤±
¤Þ¤¹¡£¤Ä¤Þ¤ê¡¢¸½ºß¤Î¥¯¥é¥¹¤È¤½¤Î¥¯¥é¥¹¤ò°Ï¤à
¥¯¥é¥¹ E ¤ò¸¡º÷¤·¤¿¤¢¤È¡¢E ¤Î¥¹¡¼¥Ñ¥¯¥é¥¹¤ò
¸¡º÷¤·¡¢ºÇ¸å¤Ë E ¤ò°Ï¤à¥¯¥é¥¹¤ò¸¡º÷¤·¤Þ¤¹¡£¼ê½ç 4 ¤È 5 ¤Ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢1 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸Æâ¤Ç¤Î¥¯¥é¥¹¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¸¡º÷¤ò¡¢
¤Ê¤ó¤é¤«¤Î·è¤Þ¤Ã¤¿½ç
½ø¤Ç¹Ô¤¦¤ï¤±¤Ç¤Ï¤¢¤ê¤Þ¤»¤ó (¤³¤Î¸¡º÷½ç½ø¤Ï¥³¥ó¥Ñ¥¤¥é¤Ë°Í¸¤·¤Þ¤¹)¡£
¼ê½ç 5 ¤Ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢
.BR java.lang
¤ò¸¡º÷¤·¤Þ¤¹¡£¤³¤ì¤Ï¡¢
.BR java.lang
¤¬¤¹¤Ù¤Æ¤Î¥×¥í¥°¥é¥à¤Ë¤è¤Ã¤Æ¼«Æ°Åª¤Ë¥¤¥ó¥Ý¡¼¥È¤µ¤ì¤ë¤¿¤á¤Ç¤¹¡£
.LP
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢É¬¤º¤·¤â¥µ¥Ö¥¯¥é¥¹¤ò¸¡º÷¤¹¤ë¤ï¤±¤Ç¤Ï¤Ê¤¯¡¢Javadoc ¥Ä¡¼¥ë¤Î
¼Â¹ÔÃæ¤Ë¤Û¤«¤Î¥Ñ¥Ã¥±¡¼¥¸
¤Î¥É¥­¥å¥á¥ó¥È¤¬À¸À®¤µ¤ì¤ë¾ì¹ç¤Ç¤â¡¢¤Û¤«¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î
¸¡º÷¤Ï¹Ô¤¤¤Þ¤»¤ó¡£
¤¿¤È¤¨¤Ð¡¢
.B @see
¥¿¥°¤¬
.B java.awt.event.KeyEvent
¥¯¥é¥¹¤Ë¤¢¤Ã¤Æ¡¢
.B java.awt
¥Ñ¥Ã¥±¡¼¥¸¤Ë¤¢¤ë̾Á°¤ò»²¾È¤¹¤ë¾ì¹ç¡¢
.B javadoc
¤Ï¡¢¤½¤Î¥¯¥é¥¹¤¬¥¤¥ó¥Ý¡¼¥È¤·¤Ê¤¤¸Â¤ê¤½¤Î¥Ñ¥Ã¥±¡¼¥¸¤ò¸¡º÷¤·¤Þ¤»¤ó¡£
.LP
.B ̾Á°¤Îɽ¼¨ÊýË¡:
.I label
¤¬¾Êά¤µ¤ì¤¿¾ì¹ç¤Ï¡¢
.I package.class.member
¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£Ä̾package.class.member ¤Ï¡¢¸½ºß¤Î
¥¯¥é¥¹¤ª¤è¤Ó¥Ñ¥Ã¥±¡¼¥¸¤Ë
±þ¤¸¤ÆŬÀÚ¤Ëû¤¯¤µ¤ì¤Þ¤¹¡£¡Öû¤¯¤µ¤ì¤ë¡×¤È¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤¬É¬Í׺Ǿ®¸Â¤Î̾Á°¤òɽ¼¨¤¹¤ë¤È¤¤¤¦¤³¤È¤Ç¤¹¡£
¤¿¤È¤¨¤Ð¡¢String.toUpperCase() ¥á¥½¥Ã¥É¤¬Æ±¤¸
¥¯¥é¥¹¤Î¥á¥ó¥Ð¤Ø¤Î»²¾È¤È¡¢Ê̤Υ¯¥é¥¹¤Î¥á¥ó¥Ð¤Ø¤Î
»²¾È¤ò´Þ¤ó¤Ç¤¤¤ë¾ì¹ç¡¢¥¯¥é¥¹Ì¾¤Ï¸å¼Ô¤Î¾ì¹ç¤À¤±É½¼¨¤µ¤ì¤Þ¤¹¡£
.LP
¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò¹­°èŪ¤Ëºï½ü¤¹¤ë¤Ë¤Ï¡¢\-noqualifier ¤ò»ÈÍѤ·¤Þ¤¹¡£
.br
.LP
.TP 4
.TS
box, center;
cbp-1 | cbp-1 | cbp-1
l | l | l .
»²¾È¤Î¼ïÎà T{
String.toUppercase() ¤Ç¤ÎÎã
T} ɽ¼¨
_
T{
@see ¥¿¥°¤¬Æ±¤¸¥¯¥é¥¹¡¢Æ±¤¸¥Ñ¥Ã¥±¡¼¥¸¤Î¥á¥ó¥Ð¤ò»²¾È¤·¤Æ¤¤¤ë
T} T{
@see String#toLowerCase()
T} T{
toLowerCase() (¥Ñ¥Ã¥±¡¼¥¸¤ª¤è¤Ó¥¯¥é¥¹Ì¾¤Ï¾Êά)
T}
_
T{
@see ¥¿¥°¤¬°Û¤Ê¤ë¥¯¥é¥¹¡¢Æ±¤¸¥Ñ¥Ã¥±¡¼¥¸¤Î¥á¥ó¥Ð¤ò»²¾È¤·¤Æ¤¤¤ë
T} T{
@see Character#toLowerCase(char)
T} T{
Character.toLowerCase(char) (¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Ï¾Êά¤·¡¢¥¯¥é¥¹Ì¾¤ò´Þ¤à)
T}
_
T{
@see ¥¿¥°¤¬°Û¤Ê¤ë¥¯¥é¥¹¡¢°Û¤Ê¤ë¥Ñ¥Ã¥±¡¼¥¸¤Î¥á¥ó¥Ð¤ò»²¾È¤·¤Æ¤¤¤ë
T} T{
@see java.io.File#exists()
T} T{
java.io.File.exists() (¥Ñ¥Ã¥±¡¼¥¸Ì¾¤È¥¯¥é¥¹Ì¾¤ò´Þ¤à)
T}
.TE
.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
.I @see
¤ò¡¢¥É¥­¥å¥á¥ó¥È²½¤ÎÂоݤˤ·¤Æ¤¤¤Ê¤¤¥¯¥é¥¹¤Ë¤Þ¤Ç³ÈÄ¥¤¹¤ë¤Ë¤Ï¡¢
.I -link
¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Þ¤¹¡£
.LP
¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@see
¤Î
.na
\f2@see ¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È\fP¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.RE
.TP 3
.BI @serial " field-description" | include | exclude
¥Ç¥Õ¥©¥ë¥È¤ÎľÎó²½²Äǽ¥Õ¥£¡¼¥ë¥É¤Î doc ¥³¥á¥ó¥È¤Ç»ÈÍѤ·¤Þ¤¹¡£
.RS
.LP
¾Êά²Äǽ¤Ê field-description ¤Ï¡¢
¥Õ¥£¡¼¥ë¥É¤Î doc ¥³¥á¥ó¥È¤ò³ÈÄ¥¤·¤Þ¤¹¡£
¤³¤ÎÀâÌÀ¤Ç¤Ï¡¢¥Õ¥£¡¼¥ë¥É¤Î°ÕÌ£¤ª¤è¤Ó
¼è¤êÆÀ¤ëÃͤΥꥹ¥È¤ò»ØÄꤷ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
ɬÍפʾì¹ç¤Ë¤Ï¡¢Ê£¿ô¤Î¹Ô¤Ë¤Þ¤¿¤¬¤Ã¤ÆÀâÌÀ¤òµ­½Ò¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
ɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤Ï¡¢¤³¤Î¾ðÊó¤ò¡¢Ä¾Î󲽤µ¤ì¤¿·Á¼°¤Î¥Ú¡¼¥¸¤ËÄɲä·¤Þ¤¹¡£
.LP
¥¯¥é¥¹¤òľÎ󲽤·¤¿¤¢¤È¤·¤Ð¤é¤¯¤·¤Æ¤«¤éľÎó²½²Äǽ¥Õ¥£¡¼¥ë¥É¤ò¥¯¥é¥¹¤ËÄɲä·¤¿¾ì¹ç¡¢¼çÀâÌÀ¤Ë¡¢Äɲä·¤¿¥Ð¡¼¥¸¥ç¥ó¤ò¼±Ê̤¹¤ëʸ¤òÄɲ乤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.LP
.BR include
¤È
.BR exclude
°ú¿ô¤Ï¡¢Ä¾Î󲽤µ¤ì¤¿·Á¼°¤Î¥Ú¡¼¥¸¤Ë¥¯¥é¥¹¤Þ¤¿¤Ï¥Ñ¥Ã¥±¡¼¥¸¤ò´Þ¤á¤ë¤Ù¤­¤«¡¢
¤¢¤ë¤¤¤Ï¤³¤ì¤é¤Î°ú¿ô¤ò½ü¤¯¤Ù¤­¤«¤ò»ØÄꤷ¤Þ¤¹¡£
¤³¤ì¤é¤Ï¡¢¼¡¤Î¤è¤¦¤ËÆ°ºî¤·¤Þ¤¹¡£
.LP
.TP 2
\(bu
.BR Serializable
¤ò¼ÂÁõ¤¹¤ë public ¥¯¥é¥¹¤Þ¤¿¤Ï protected ¥¯¥é¥¹¤Ï¡¢
¤½¤Î¥¯¥é¥¹ (¤Þ¤¿¤Ï¤½¤Î¥Ñ¥Ã¥±¡¼¥¸) ¤¬
.BR @serial
.BR exclude
¤È¥Þ¡¼¥¯¤µ¤ì¤Æ¤¤¤Ê¤¤¸Â¤ê´Þ¤á¤é¤ì¤Þ¤¹¡£
.TP 2
\(bu
.BR Serializable
¤ò¼ÂÁõ¤¹¤ë private ¥¯¥é¥¹¤Þ¤¿¤Ï package\-private ¥¯¥é¥¹¤Ï¡¢
¤½¤Î¥¯¥é¥¹ (¤Þ¤¿¤Ï¤½¤Î¥Ñ¥Ã¥±¡¼¥¸) ¤¬
.BR @serial
.BR include
¤È¥Þ¡¼¥¯¤µ¤ì¤Æ¤¤¤Ê¤¤¸Â¤ê½ü¤«¤ì¤Þ¤¹¡£
.LP
Îã:
.BR javax.swing
¥Ñ¥Ã¥±¡¼¥¸¤Ï¡¢(package.html ¤Þ¤¿¤Ï \f2package\-info.java\fP Æâ¤Ç)
.BR @serial
.BR exclude
¤È¥Þ¡¼¥¯¤µ¤ì¤Þ¤¹¡£
public ¥¯¥é¥¹¤Ç¤¢¤ë
.BR java.sercurity.BasicPermission
¤Ï¡¢
.BR @serial
.BR exclude
¤È¥Þ¡¼¥¯¤µ¤ì¤Þ¤¹¡£package\-private ¥¯¥é¥¹¤Ç¤¢¤ë
.BR java.util.PropertyPermissionCollection
¤Ï¡¢
.BR @serial
.BR include
¤È¥Þ¡¼¥¯¤µ¤ì¤Þ¤¹¡£
.LP
¥¯¥é¥¹¥ì¥Ù¥ë¤Î¥¿¥°
.BR @serial
¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸¥ì¥Ù¥ë¤Î
.BR @serial
¤ò¥ª¡¼¥Ð¡¼¥é¥¤¥É¤·¤Þ¤¹¡£
.LP
¤³¤ì¤é¤Î¥¿¥°¤Î»ÈÍÑË¡¤Ë¤Ä¤¤¤Æ¤Î¾ÜºÙ¤È»ÈÍÑÎã¤Ï¡¢¡ÖJava ¥ª¥Ö¥¸¥§¥¯¥ÈľÎó²½»ÅÍ͡פÎÂè 1.6 Àá¡Ö¥¯¥é¥¹¤ÎľÎó²½²Äǽ¤Ê¥Õ¥£¡¼¥ë¥É¤ª¤è¤Ó¥Ç¡¼¥¿¤Îʸ½ñ²½¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£¤Þ¤¿¡¢
.fi
http://java.sun.com/products/jdk/serialization/faq/#javadoc_warn_missing
¤Î
.na
¡Ö\f2ľÎ󲽤ΠFAQ\fP¡×¤â»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£¤³¤Î FAQ ¤Ë¤Ï¡¢¡Ö\-private ¥¹¥¤¥Ã¥Á¤ò»ØÄꤷ¤Ê¤¤¤Ç javadoc ¤ò¼Â¹Ô¤·¤Æ¤¤¤ë¤Î¤Ë private ¥Õ¥£¡¼¥ë¥É¤Î @serial ¥¿¥°¤¬¸«¤Ä¤«¤é¤Ê¤¤¤È¤¤¤¦ javadoc ¤Î·Ù¹ð¤¬É½¼¨¤µ¤ì¤ë¡×¤Ê¤É¤Î°ìÈÌŪ¤Ê¼ÁÌä¤Ø¤Î²óÅú¤¬µ­ºÜ¤µ¤ì¤Æ¤¤¤Þ¤¹¡£Ä¾Îó²½·Á¼°»ÅÍͤ˥¯¥é¥¹¤ò´Þ¤á¤ë¾ì¹ç¤Ë¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/writingapispecs/serialized\-criteria.html
¤Î
.na
¡Ö\f2Sun ¤Î»ÅÍÍ\fP¡×¤â»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.RE
.TP
.BI @serialField " field-name field-type field-description"
Serializable ¥¯¥é¥¹¤Î serialPersistentFields ¥á¥ó¥Ð¤Î ObjectStreamField ¥³¥ó¥Ý¡¼¥Í¥ó¥È
¤ò¥É¥­¥å¥á¥ó¥È²½¤·¤Þ¤¹¡£³Æ ObjectStreamField ¥³¥ó¥Ý¡¼¥Í¥ó¥È¤ËÂФ·¤Æ
.B @serialField
¥¿¥°¤ò 1 ¤Ä»È¤¦É¬Íפ¬¤¢¤ê¤Þ¤¹¡£
.TP
.BI @serialData " data-description"
.I data-description
¤Ï¡¢Ä¾Î󲽤µ¤ì¤¿·Á¼°¤Ç¤Î¥Ç¡¼¥¿¤Î·¿¤È½ç½ø¤ò
ÀâÌÀ¤¹¤ë¥Æ¥­¥¹¥È¤Ç¤¹¡£ ¤³¤Î¥Ç¡¼¥¿¤Ë¤Ï¡¢
Æäˡ¢writeObject ¥á¥½¥Ã¥É¤Ë¤è¤Ã¤Æ½ñ¤­¹þ¤Þ¤ì¤ë¾Êά²Äǽ¤Ê
¥Ç¡¼¥¿¡¢¤ª¤è¤Ó Externalizable.writeExternal ¥á¥½¥Ã¥É¤Ë¤è¤Ã¤Æ
½ñ¤­¹þ¤Þ¤ì¤ë¤¹¤Ù¤Æ¤Î¥Ç¡¼¥¿ (´ðÄ쥯¥é¥¹¤ò´Þ¤à) ¤¬´Þ¤Þ¤ì¤Þ¤¹¡£
.TP
.B @serialData
¥¿¥°¤Ï¡¢writeObject¡¢readObject¡¢writeExternal¡¢¤ª¤è¤Ó readExternal ¤Î³Æ¥á¥½¥Ã¥É¤Î
doc ¥³¥á¥ó¥È¤Ç»ÈÍѤǤ­¤Þ¤¹¡£
.LP
.TP 3
@since\ since\-text
À¸À®¥É¥­¥å¥á¥ó¥È¤Ë¡ÖƳÆþ¤µ¤ì¤¿¥Ð¡¼¥¸¥ç¥ó¡×¸«½Ð¤·¤òÄɲä·¡¢»ØÄꤵ¤ì¤¿ \f2since\-text\fP ¤ò½ñ¤­¹þ¤ß¤Þ¤¹¡£¤³¤Î¥Æ¥­¥¹¥È¤Ë¤Ï¡¢ÆÃÊ̤ÊÆâÉô¹½Â¤¤Ï¤¢¤ê¤Þ¤»¤ó¡£¤³¤Î¥¿¥°¤Ï¡¢¤¹¤Ù¤Æ¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¡¢¤Ä¤Þ¤ê³µÍס¢¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¤ª¤è¤Ó¥Õ¥£¡¼¥ë¥É¤ÇÍ­¸ú¤Ç¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢ÆÃÄê¤ÎÊѹ¹¤Þ¤¿¤Ïµ¡Ç½¤¬¡¢\f2since\-text\fP ¤Ë¼¨¤µ¤ì¤¿¥½¥Õ¥È¥¦¥§¥¢¥ê¥ê¡¼¥¹°Ê¹ß¡¢Â¸ºß¤·¤Æ¤¤¤ë¤³¤È¤ò°ÕÌ£¤·¤Þ¤¹¡£¼¡¤ËÎã¤ò¼¨¤·¤Þ¤¹¡£
.nf
\f3
.fl
@since 1.5
.fl
\fP
.fi
Java ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à¤Î¥½¡¼¥¹¥³¡¼¥É¤Î¾ì¹ç¡¢¤³¤Î¥¿¥°¤Ï¡¢Java ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à API »ÅÍͤΥС¼¥¸¥ç¥ó¤ò¼¨¤·¤Þ¤¹¡£¤½¤ÎÊѹ¹¤äµ¡Ç½¤¬¥ê¥Õ¥¡¥ì¥ó¥¹¼ÂÁõ¤ËÄɲ䵤줿»þ´ü¤ò¼¨¤¹¤È¤Ï¸Â¤ê¤Þ¤»¤ó¡£Ê£¿ô¤Î @since ¥¿¥°¤ò»ÈÍѤǤ­¡¢Ê£¿ô¤Î @author ¥¿¥°¤Î¤è¤¦¤Ë°·¤ï¤ì¤Þ¤¹¡£¥×¥í¥°¥é¥àÍ×ÁǤ¬Ê£¿ô¤Î API ¤Ç»ÈÍѤµ¤ì¤ë¾ì¹ç¡¢Ê£¿ô¤Î¥¿¥°¤ò»ÈÍѤǤ­¤Þ¤¹¡£
.RE
.TP
.BI @throws " class-name description"
.B @throws
¥¿¥°¤È
.B @exception
¥¿¥°¤ÏƱµÁ¤Ç¤¹¡£À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¤Ë¡¢
.I class-name
¤ª¤è¤Ó
.I description
¥Æ¥­¥¹¥È¤ò»ý¤Ä [Îã³°] ¾®¸«½Ð¤·¤òÄɲä·¤Þ¤¹¡£
.I class-name
¤Ï¡¢³ºÅö¤¹¤ë¥á¥½¥Ã¥É¤Ë¤è¤Ã¤Æ
¥¹¥í¡¼¤µ¤ì¤ë²ÄǽÀ­¤Î¤¢¤ëÎã³°¤Î̾Á°¤Ç¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢doc ¥³¥á¥ó¥È¤Þ¤¿¤Ï¥³¥ó¥¹¥È¥é¥¯¥¿¤Ç¤Î¤ßÍ­¸ú¤Ç¤¹¡£¤³¤Î¥¯¥é¥¹¤¬´°Á´
½¤¾þ¤µ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¸¡º÷½ç½ø¤Ë½¾¤Ã¤Æ¥¯¥é¥¹¤òõ¤·¤Þ¤¹¡£
Ʊ¤¸¤Þ¤¿¤Ï°Û¤Ê¤ëÎã³°¤Î doc ¥³¥á¥ó¥È¤Ç¡¢
Ê£¿ô¤Î @throws ¥¿¥°¤ò»ÈÍѤǤ­¤Þ¤¹¡£
.LP
¤¹¤Ù¤Æ¤Î¥Á¥§¥Ã¥¯ºÑ¤ßÎã³°¤¬¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¤è¤¦¤Ë¤¹¤ë¤¿¤á¤Ë¡¢
@throws ¥¿¥°¤¬ throws ÀáÆâ¤ÎÎã³°ÍѤ˸ºß¤·¤Ê¤¤¾ì¹ç¤Ï¡¢
@throws ¥¿¥°¤Î¤¢¤ë¥É¥­¥å¥á¥ó¥È¤Ç¤¢¤ë¤«¤Î¤è¤¦¤Ë¡¢
.B Javadoc
¥Ä¡¼¥ë¤Ë¤è¤Ã¤ÆÎã³°¤¬ HTML ½ÐÎϤËÀâÌÀ¤Ê¤·¤Ç
¼«Æ°Åª¤ËÄɲ䵤ì¤Þ¤¹¡£
.LP
¥ª¡¼¥Ð¡¼¥é¥¤¥É¤µ¤ì¤¿¥á¥½¥Ã¥É¤ÇÌÀ¼¨Åª¤ËÎã³°¤¬Àë¸À¤µ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ë¸Â¤Ã¤Æ¡¢
¥ª¡¼¥Ð¡¼¥é¥¤¥É¤µ¤ì¤¿¥á¥½¥Ã¥É¤«¤é¥µ¥Ö¥¯¥é¥¹¤Ø
@throws ¥É¥­¥å¥á¥ó¥È¤¬¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£
¥¤¥ó¥¿¥Õ¥§¡¼¥¹¥á¥½¥Ã¥É¤«¤é¼ÂÁõ¥á¥½¥Ã¥É¤Ë¥³¥Ô¡¼¤µ¤ì¤ë¾ì¹ç¤â
ƱÍͤǤ¹¡£{@inheritDoc} ¤ò»ÈÍѤ·¤Æ¡¢·Ñ¾µ¥É¥­¥å¥á¥ó¥È¤ËÂФ·¤Æ
¶¯À©Åª¤Ë @throws ¤òŬÍѤ¹¤ë¤³¤È¤â²Äǽ¤Ç¤¹¡£
.LP
¾ÜºÙ¤Ï
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@exception
¤Î
.na
\f2@throws ¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È\fP¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP
.B {@value package.class#field}
{@value} ¤¬ÀÅŪ¥Õ¥£¡¼¥ë¥É¤Î doc ¥³¥á¥ó¥È¤Ç
°ú¿ô¤Ê¤·¤Ç»ÈÍѤµ¤ì¤Æ¤¤¤ë¾ì¹ç¡¢¤½¤ÎÄê¿ô¤ÎÃͤ¬É½¼¨¤µ¤ì¤Þ¤¹¡£
.LP
.RS 5
.nf
/**
* The value of this constant is {@value}.
*/
public static final String SCRIPT_START = "<script>"
.fi
.RE
.LP
Ǥ°Õ¤Î doc ¥³¥á¥ó¥ÈÆâ¤Ç°ú¿ô
.B package.class#field
¤¢¤ê¤Ç»ÈÍѤµ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢»ØÄꤷ¤¿Äê¿ô¤ÎÃͤ¬É½¼¨¤µ¤ì¤Þ¤¹¡£
.LP
.RS 5
.nf
/**
* Evaluates the script starting with {@value #SCRIPT_START}.
*/
public String evalScript(String script) {
}
.fi
.RE
.LP
°ú¿ô package.class#field ¤Ï¡¢@see °ú¿ô¤ÈƱ°ì¤Î·Á¼°¤Ë¤Ê¤ê¤Þ¤¹¡£
¤¿¤À¤·¡¢¥á¥ó¥Ð¤¬ÀÅŪ¥Õ¥£¡¼¥ë¥É¤Ë¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤ÅÀ¤¬°Û¤Ê¤ê¤Þ¤¹¡£
.LP
¤³¤ì¤é¤ÎÄê¿ô¤Ç¤ÎÃͤϡ¢¡ÖÄê¿ô¥Õ¥£¡¼¥ë¥ÉÃ͡ץڡ¼¥¸¤Ë¤âɽ¼¨¤µ¤ì¤Þ¤¹¡£
.TP
.BI @version " version-text"
\-version ¥ª¥×¥·¥ç¥ó¤¬»È¤ï¤ì¤Æ¤¤¤ë¾ì¹ç¡¢À¸À®¥É¥­¥å¥á¥ó¥È¤Ë¡Ö¥Ð¡¼¥¸¥ç¥ó¡×¾®¸«½Ð¤·¤òÄɲ䷤ơ¢»ØÄꤵ¤ì¤¿ \f2version\-text\fP ¤ò½ñ¤­¹þ¤ß¤Þ¤¹¡£¤³¤Î¥¿¥°¤Ï¡¢¤³¤Î¥³¡¼¥É¤¬´Þ¤Þ¤ì¤ë¥½¥Õ¥È¥¦¥§¥¢¤Î¸½ºß¤Î¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤òÊÝ»ý¤¹¤ë¤è¤¦¤Ë°Õ¿Þ¤µ¤ì¤Æ¤¤¤Þ¤¹¡£¤³¤ì¤ËÂФ·¡¢@since ¤Ï¡¢¤³¤Î¥³¡¼¥É¤¬Æ³Æþ¤µ¤ì¤¿¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤òÊÝ»ý¤·¤Þ¤¹¡£\f2version\-text\fP ¤Ë¤Ï¡¢ÆÃÊ̤ÊÆâÉô¹½Â¤¤Ï¤¢¤ê¤Þ¤»¤ó¡£¥Ð¡¼¥¸¥ç¥ó¥¿¥°¤ò»ÈÍѤǤ­¤ë¾ì½ê¤òÄ´¤Ù¤ë¤Ë¤Ï¡¢¡Ö¥¿¥°¤ò»ÈÍѤǤ­¤ë¾ì½ê¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
1 ¤Ä¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ËÊ£¿ô¤Î \f2@version\fP ¥¿¥°¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£É¬Íפ˱þ¤¸¤Æ¡¢\f2@version\fP ¥¿¥°¤´¤È¤Ë 1 ¤Ä¤Î¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤ò»ØÄꤹ¤ë¤³¤È¤â¡¢¥¿¥°¤´¤È¤ËÊ£¿ô¤Î¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤ò»ØÄꤹ¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£Á°¼Ô¤Î¾ì¹ç¤Ï¡¢Javadoc ¥Ä¡¼¥ë¤Ë¤è¤Ã¤Æ¡¢Ì¾Á°¤È̾Á°¤Î´Ö¤Ë¥³¥ó¥Þ (\f2,\fP) ¤È¥¹¥Ú¡¼¥¹¤¬ÁÞÆþ¤µ¤ì¤Þ¤¹¡£¸å¼Ô¤Î¾ì¹ç¤Ï¡¢¥Æ¥­¥¹¥ÈÁ´ÂΤ¬¡¢²òÀϤµ¤ì¤ë¤³¤È¤Ê¤¯¡¢À¸À®¥É¥­¥å¥á¥ó¥È¤Ë¤½¤Î¤Þ¤Þ¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£¤·¤¿¤¬¤Ã¤Æ¡¢¥³¥ó¥Þ¤Ç¤Ï¤Ê¤¯¡¢³Æ¸À¸ì¤ËÂбþ¤·¤¿Ì¾Á°¶èÀÚ¤êʸ»ú¤ò»È¤¦É¬Íפ¬¤¢¤ë¾ì¹ç¤Ï¡¢1 ¤Ä¤Î¥¿¥°¤ËÊ£¿ô¤Î̾Á°¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
.LP
¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#@version
¤Î
.na
\f2@version ¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È\fP¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.SS "¥¿¥°¤ò»ÈÍѤǤ­¤ë¾ì½ê"
°Ê²¼¤Ç¤Ï¡¢¥¿¥°¤ò»ÈÍѤǤ­¤ë¾ì½ê¤Ë¤Ä¤¤¤ÆÀâÌÀ¤·¤Þ¤¹¡£@see¡¢@since¡¢@deprecated¡¢{@link}¡¢{@linkplain} ¤ª¤è¤Ó {@docroot} ¤Î¥¿¥°¤Ï¡¢¤¹¤Ù¤Æ¤Î doc ¥³¥á¥ó¥È¤Ç»ÈÍѤǤ­¤Þ¤¹¡£
.SS "³µÍץɥ­¥å¥á¥ó¥È¥¿¥°"
³µÍ×¥¿¥°¤Ï¡¢³µÍ×¥Ú¡¼¥¸¤Î¥É¥­¥å¥á¥ó¥È
¥³¥á¥ó¥È (Ä̾ï¤Ï \f3overview.html\f1
¤È¤¤¤¦Ì¾Á°¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ëÆâ¤Ë¤¢¤ë) ¤Ç»ÈÍѤǤ­¤ë¥¿¥°¤Ç¤¹¡£
¤Û¤«¤Î¥É¥­¥å¥á¥ó¥È
¥³¥á¥ó¥È¤ÈƱÍͤˡ¢¤³¤ì¤é¤Î¥¿¥°¤Ï¡¢ÀâÌÀ¤Î¤¢¤È¤Ç»È¤¦É¬Íפ¬¤¢¤ê¤Þ¤¹¡£
.LP
Ãí:¥Ð¡¼¥¸¥ç¥ó 1.2 ¤Ç¤Ï¡¢³µÍץɥ­¥å¥á¥ó¥ÈÆâ¤Î {\f3@link\f1} ¥¿¥°¤Ë
¥Ð¥°¤¬¤¢¤ê¤Þ¤¹¡£¥Æ¥­¥¹¥È¤ÏŬÀÚ¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¤¬¡¢
¥ê¥ó¥¯¤¬ÀßÄꤵ¤ì¤Þ¤»¤ó¡£
¸½ºß¤Î¤È¤³¤í¡¢{\f2@docRoot\f1} ¥¿¥°¤Ï¡¢
³µÍץɥ­¥å¥á¥ó¥ÈÆâ¤Ç¤ÏÆ°ºî¤·¤Þ¤»¤ó¡£
.LP
.LP
.TS
;
cbp-1
l .
³µÍ×¥¿¥°
@see
@since
@author
@version
{@link}
{@linkplain}
{@docRoot}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-20
.LP
.SS "¥Ñ¥Ã¥±¡¼¥¸¥É¥­¥å¥á¥ó¥È¥¿¥°"
¥Ñ¥Ã¥±¡¼¥¸¥¿¥°¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸¤Î¥É¥­¥å¥á¥ó¥È
¥³¥á¥ó¥È (\f3package.html\f1 ¤Þ¤¿¤Ï \f2package\-info.java\fP ¤È¤¤¤¦
̾Á°¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ë¸ºß) ¤Ç»ÈÍѤǤ­¤ë¥¿¥°¤Ç¤¹¡£
¤³¤³¤Ç»ÈÍѤǤ­¤ë @serial ¥¿¥°¤Ï¡¢include ¤Þ¤¿¤Ï
exclude °ú¿ô¤ò»ØÄꤷ¤¿¤â¤Î¤À¤±¤Ç¤¹¡£
.LP
.LP
.TS
;
cbp-1
l .
¥Ñ¥Ã¥±¡¼¥¸¥¿¥°
@see
@since
@serial
@author
@version
{@link}
{@linkplain}
{@docRoot}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-22
.LP
.SS "¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¥É¥­¥å¥á¥ó¥È¥¿¥°"
¼¡¤Ë¼¨¤¹¤Î¤Ï¡¢¥¯¥é¥¹¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î¥É¥­¥å¥á¥ó¥È
¥³¥á¥ó¥È¤Ç»ÈÍѤǤ­¤ë¥¿¥°¤Ç¤¹¡£
¤³¤³¤Ç»ÈÍѤǤ­¤ë @serial ¥¿¥°¤Ï¡¢
include ¤Þ¤¿¤Ï exclude °ú¿ô¤ò»ØÄꤷ¤¿¤â¤Î¤À¤±¤Ç¤¹¡£
.LP
.LP
.TS
;
cbp-1
l .
¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹¥¿¥°
@see
@since
@deprecated
@serial
@author
@version
{@link}
{@linkplain}
{@docRoot}
.TE
.LP
¼¡¤Ï¡¢¥¯¥é¥¹¥³¥á¥ó¥È¤ÎÎã¤Ç¤¹¡£
.LP
.RS
.ft 3
.nf
/**
* A class representing a window on the screen.
* For example:
* <pre>
* Window win = new Window(parent);
* win.show();
* </pre>
*
* @author Sami Shaio
* @version 1.13, 06/08/06
* @see java.awt.BaseWindow
* @see java.awt.Button
*/
class Window extends BaseWindow {
...
}
.fi
.ft 1
.RE
.SS "¥Õ¥£¡¼¥ë¥É¥É¥­¥å¥á¥ó¥È¥¿¥°"
¼¡¤Ë¼¨¤¹¤Î¤Ï¡¢¥Õ¥£¡¼¥ë¥É¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤Ç
»ÈÍѤǤ­¤ë¥¿¥°¤Ç¤¹¡£
.LP
.LP
.TS
;
cbp-1
l .
¥Õ¥£¡¼¥ë¥É¥¿¥°
@see
@since
@deprecated
@serial
@serialField
{@link}
{@linkplain}
{@docRoot}
{@value}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-24
.LP
¼¡¤Ï¡¢¥Õ¥£¡¼¥ë¥É¥³¥á¥ó¥È¤ÎÎã¤Ç¤¹¡£
.LP
.RS
.ft 3
.nf
/**
* The X-coordinate of the component.
*
* @see #getLocation()
*/
int x = 1263732;
.fi
.ft 1
.RE
.SS "¥³¥ó¥¹¥È¥é¥¯¥¿¤ª¤è¤Ó¥á¥½¥Ã¥É¥É¥­¥å¥á¥ó¥È¥¿¥°"
¼¡¤Ë¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¤Þ¤¿¤Ï¥á¥½¥Ã¥É¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥ÈÆâ¤Çɽ¼¨¤Ç¤­¤ë¥¿¥°¤ò¼¨¤·¤Þ¤¹¡£¤¿¤À¤·¡¢@return ¤Ï¥³¥ó¥¹¥È¥é¥¯¥¿¤Ç¤Ïɽ¼¨¤Ç¤­¤º¡¢{@inheritDoc} ¤Ï
ɽ¼¨¤ËÀ©¸Â¤¬¤¢¤ê¤Þ¤¹¡£@serialData ¥¿¥°¤ÏÆÃÄê¤ÎľÎ󲽥᥽¥Ã¥É¤Î doc ¥³¥á¥ó¥È¤Ç¤Î¤ß»ÈÍѤǤ­¤Þ¤¹¡£
.LP
.LP
.TS
;
cbp-1
l .
¥á¥½¥Ã¥É¤ª¤è¤Ó¥³¥ó¥¹¥È¥é¥¯¥¿¥¿¥°
@see
@since
@deprecated
@param
@return
@throws and @exception
@serialData
{@link}
{@linkplain}
{@inheritDoc}
{@docRoot}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-28
.LP
¼¡¤Ï¥á¥½¥Ã¥É¤Î doc ¥³¥á¥ó¥È¤ÎÎã¤Ç¤¹¡£
.LP
.RS
.ft 3
.nf
/**
* Returns the character at the specified index. An index
* ranges from <code>0</code> to <code>length() - 1</code>.
*
* @param index the index of the desired character.
* @return the desired character.
* @exception StringIndexOutOfRangeException
* if the index is not in the range <code>0</code>
* to <code>length()-1</code>.
* @see java.lang.Character#charValue()
*/
public char charAt(int index) {
...
}
.fi
.ft 1
.RE
.SH "¥ª¥×¥·¥ç¥ó"
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥É¥Ã¥¯¥ì¥Ã¥È¤ò»È¤Ã¤Æ½ÐÎϤò·èÄꤷ¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢
.B \-doclet
¥ª¥×¥·¥ç¥ó¤Ç¥«¥¹¥¿¥à¥É¥Ã¥¯¥ì¥Ã¥È¤¬»ØÄꤵ¤ì¤Æ¤¤¤ë¾ì¹ç°Ê³°¤Ï¡¢
¥Ç¥Õ¥©¥ë¥È¤Îɸ½à¥É¥Ã¥¯
¥ì¥Ã¥È¤ò»È¤¤¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ë¤Ï¡¢Ç¤°Õ¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤È¤È¤â¤Ë»ÈÍѤǤ­¤ë¥³¥Þ¥ó¥É¹Ô
¥ª¥×¥·¥ç¥ó¤¬¤¢¤ê¤Þ¤¹¡£¤³¤ì¤é¤Î¥ª¥×
¥·¥ç¥ó¤Ë¤Ä¤¤¤Æ¤Ï¡¢¸å½Ò¤Î¡Öjavadoc ¤Î¥ª¥×¥·¥ç¥ó¡×¤ÇÀâÌÀ¤·¤Þ¤¹¡£
ɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤Ç¤Ï¡¢¤³
¤Î¤Û¤«¤Ë¡¢¤¤¤¯¤Ä¤«¤ÎÄɲäΥ³¥Þ¥ó¥É¹Ô¥ª¥×¥·¥ç¥ó¤¬Ä󶡤µ¤ì¤Þ¤¹¡£
¤³¤ì¤é¤Î¥ª¥×¥·¥ç¥ó¤Ë
¤Ä¤¤¤Æ¤Ï¡¢¸å½Ò¤Î¡Öɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤¬Ä󶡤¹¤ë¥ª¥×¥·¥ç¥ó¡×¤Ç
ÀâÌÀ¤·¤Þ¤¹¡£¤É¤Î¥ª¥×¥·¥ç¥ó
̾¤âÂçʸ»ú¤È¾®Ê¸»ú¤ò¶èÊ̤·¤Þ¤»¤ó¡£¤¿¤À¤·¡¢¥ª¥×¥·¥ç¥ó¤Î°ú¿ô¤Ç¤Ï
Âçʸ»ú¤È¾®Ê¸»ú¤¬¶è
Ê̤µ¤ì¤ë¤³¤È¤¬¤¢¤ê¤Þ¤¹¡£
.LP
¥ª¥×¥·¥ç¥ó¤ò°Ê²¼¤Ë¼¨¤·¤Þ¤¹¡£
.LP
.RS 3
.LP
.LP
.TS
center;
li l li
l li li
li l li
l li li
li l l
l l li
li l li
l l l
l li l
l l li
li l l
li l l
l l l
li l l
li l l
l l li
li l l
l l l
l l l
l li l
l li l.
-1.1 -header -private
-author -help -protected
-bootclasspath -helpfile -public
-bottom -J -quiet
-breakiterator -keywords -serialwarn
-charset -link -source
-classpath -linkoffline -sourcepath
-d -linksource -splitindex
-docencoding -locale -stylesheetfile
-docfilessubdirs -nocomment -subpackages
-doclet -nodeprecated -tag
-docletpath -nodeprecatedlist -taglet
-doctitle -nohelp -tagletpath
-encoding -noindex -title
-exclude -nonavbar -use
-excludedocfilessubdir -noqualifier -verbose
-extdirs -nosince -version
-footer -notimestamp -windowtitle
-group -notree
-overview
-package
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-123
.LP
.RE
.LP
\f2²¼ÀþÉÕ¤­\fP¤Ç¼¨¤µ¤ì¤¿¥ª¥×¥·¥ç¥ó¤Ï¡¢Javadoc ¤Î´ðËÜ¥ª¥×¥·¥ç¥ó¤Ç¤¢¤ê¡¢Javadoc ¥Ä¡¼¥ë¤Î¥Õ¥í¥ó¥È¥¨¥ó¥É¤Ë¤è¤Ã¤ÆÄ󶡤µ¤ì¡¢¤¹¤Ù¤Æ¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤Ç»ÈÍѤǤ­¤Þ¤¹¡£É¸½à¥É¥Ã¥¯¥ì¥Ã¥È¼«ÂΤϡ¢²¼ÀþÉÕ¤­¤Ç¤Ê¤¤¥ª¥×¥·¥ç¥ó¤òÄ󶡤·¤Þ¤¹¡£
.LP
.SS "Javadoc ¤Î¥ª¥×¥·¥ç¥ó"
.TP
.BI \-overview " path/filename"
.B javadoc
¤ËÂФ·¤Æ¡¢
.I path/filename
¤Ç»ØÄꤵ¤ì¤¿¡Ö¥½¡¼¥¹¡×¥Õ¥¡¥¤¥ë¤«¤é
³µÍץɥ­¥å¥á¥ó¥ÈÍѤΥƥ­¥¹¥È
¤ò¼èÆÀ¤·¡¢³µÍ×¥Ú¡¼¥¸ (\f3overview-summary.html\f1) ¤ËÇÛÃÖ¤¹¤ë¤³¤È¤ò
»Ø¼¨¤·¤Þ¤¹¡£
.I path/filename
¤Ï¡¢
.BR \-sourcepath
¤Ø¤ÎÁêÂХѥ¹¤Ç¤¹¡£
.LP
.RS
.I filename
¤È
.IR path
¤Ë¤Ï¡¢¤½¤ì¤¾¤ìǤ°Õ¤Î̾Á°¤È¾ì½ê¤ò»ØÄê¤Ç¤­¤Þ¤¹¤¬¡¢Ä̾ï¤Ï¡¢
.B overview.html
¤È¤¤¤¦Ì¾Á°¤òÉÕ¤±¤Æ¡¢¥½¡¼¥¹¥Ä¥ê¡¼Æâ¤ÎºÇ¾å°Ì¤Î
¥Ñ¥Ã¥±¡¼¥¸¥Ç¥£¥ì¥¯¥È¥ê¤ò´Þ¤à¥Ç¥£¥ì¥¯¥È¥ê
¤ËÇÛÃÖ¤·¤Þ¤¹¡£¤³¤Î¾ì½ê¤Ç¤Ï¡¢
.B \-sourcepath
¤¬¤³¤Î¥Õ¥¡¥¤¥ë¤ò»Ø¤¹¤Î¤Ç¡¢¥Ñ¥Ã¥±¡¼¥¸¤ò
¥É¥­¥å¥á¥ó¥È²½¤¹¤ëºÝ¤Ë path ¤¬É¬Íפ¢¤ê¤Þ¤»¤ó¡£
¤¿¤È¤¨¤Ð¡¢java.lang ¥Ñ¥Ã¥±¡¼¥¸¤Î¥½¡¼¥¹¥Ä¥ê¡¼¤¬
.BR /src/classes/java/lang/
¤Î¾ì¹ç¡¢³µÍ×¥Õ¥¡¥¤¥ë¤ò
.BR /src/classes/overview.html
¤ËÇÛÃ֤Ǥ­¤Þ¤¹¡£¡Ö»ÈÍÑÎã¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.IR path/filename
¤Ç»ØÄꤹ¤ë¥Õ¥¡¥¤¥ë¤Ë¤Ä¤¤¤Æ¤Ï¡¢
¡Ö³µÍ×¥³¥á¥ó¥È¥Õ¥¡¥¤¥ë¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
³µÍ×¥Ú¡¼¥¸¤¬ºîÀ®¤µ¤ì¤ë¤Î¤Ï¡¢
.B javadoc
¤Ë 2 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤òÅϤ·¤¿¾ì¹ç¤À¤±¤Ç¤¹¡£
¾ÜºÙ¤Ï¡¢¡ÖHTML ¥Õ¥ì¡¼¥à¡×
Àá¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
³µÍ×¥Ú¡¼¥¸¤Î¥¿¥¤¥È¥ë¤Ï¡¢
.B \-doctitle
¤Ë¤è¤Ã¤ÆÀßÄꤵ¤ì¤Þ¤¹¡£
.RE
.TP
.B \-public
public ¤Ê¥¯¥é¥¹¤È¥á¥ó¥Ð¤À¤±¤òɽ¼¨¤·¤Þ¤¹¡£
.TP
.B \-protected
protected ¤ª¤è¤Ó public ¤Ê¥¯¥é¥¹¤È¥á¥ó¥Ð¤À¤±¤òɽ¼¨¤·¤Þ¤¹¡£
¤³¤ì¤Ï¥Ç¥Õ¥©¥ë¥È¤ÎÆ°ºî¤Ç¤¹¡£
.TP
.B \-package
¥Ñ¥Ã¥±¡¼¥¸¡¢¤ª¤è¤Ó protected ¤È public ¤Ê
¥¯¥é¥¹¤È¥á¥ó¥Ð¤À¤±¤òɽ¼¨¤·¤Þ¤¹¡£
.TP
.B \-private
¤¹¤Ù¤Æ¤Î¥¯¥é¥¹¤È¥á¥ó¥Ð¤òɽ¼¨¤·¤Þ¤¹¡£
.TP
.B \-help
¥ª¥ó¥é¥¤¥ó¥Ø¥ë¥×¤òɽ¼¨¤·¤Þ¤¹¡£
.B javadoc
¤È¥É¥Ã¥¯¥ì¥Ã¥È¤Î¥³¥Þ¥ó¥É¹Ô¥ª¥×¥·¥ç¥ó¤Î°ìÍ÷¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£
.TP
.BI \-doclet " class"
¥É¥­¥å¥á¥ó¥È¤ÎÀ¸À®¤Ë»È¤¦
¥É¥Ã¥¯¥ì¥Ã¥È¤òµ¯Æ°¤¹¤ë¤¿¤á¤Î¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤ò»ØÄꤷ¤Þ¤¹¡£
´°Á´»ØÄê¤Î̾Á°¤ò»ØÄꤷ¤Æ¤¯¤À¤µ¤¤¡£
¥É¥Ã¥¯¥ì¥Ã¥È¤Ç¤Ï¡¢½ÐÎϤÎÆâÍƤȷÁ¼°¤òÄêµÁ¤·¤Þ¤¹¡£
.B \-doclet
¥ª¥×¥·¥ç¥ó¤¬»È¤ï¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
.B javadoc
¤Ïɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤ò»È¤Ã¤Æ¥Ç¥Õ¥©¥ë¥È¤Î HTML ·Á¼°¤òÀ¸À®¤·¤Þ¤¹¡£
¤³¤Î¥¯¥é¥¹¤Ë¤Ï¡¢
start(Root) ¥á¥½¥Ã¥É¤¬´Þ¤Þ¤ì¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
¤³¤Îµ¯Æ°¥¯¥é¥¹¤Ø¤Î¥Ñ¥¹¤Ï¡¢
.B \-docletpath
¥ª¥×¥·¥ç¥ó¤Ë¤è¤Ã¤ÆÄêµÁ¤µ¤ì¤Þ¤¹¡£
.LP
¤¿¤È¤¨¤Ð¡¢MIF ¥É¥Ã¥¯¥ì¥Ã¥È¤ò¸Æ¤Ó½Ð¤¹¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë»ØÄꤷ¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
-doclet com.sun.tools.doclets.mif.MIFDoclet
.fi
.ft 1
.LP
ÆÃÄê¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤ò¼Â¹Ô¤·¤¿´°Á´¤ÊÎã¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet
¤Î
.na
¡Ö\f2Running the MIF Doclet\fP¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.RE
.TP
.BI \-docletpath " classpathlist"
.B \-doclet
¥ª¥×¥·¥ç¥ó¤Ç»ØÄꤵ¤ì¤Æ¤¤¤ë¥É¥Ã¥¯¥ì¥Ã¥È¥¯¥é¥¹¥Õ¥¡¥¤¥ë¡¢
¤ª¤è¤Ó¤½¤ì¤Ë°Í¸¤¹¤ë jar ¥Õ¥¡¥¤¥ë¤Ø¤Î¥Ñ¥¹¤ò»ØÄꤷ¤Þ¤¹¡£
µ¯Æ°¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤¬ jar ¥Õ¥¡¥¤¥ëÆâ¤Ë¤¢¤ë¾ì¹ç¡¢
Îã¤Ë½¾¤Ã¤Æ¡¢¤½¤Î jar ¥Õ¥¡¥¤¥ë¤Ø¤Î¥Ñ¥¹¤ò»ØÄꤷ¤Þ¤¹¡£
ÀäÂХѥ¹¡¢¤Þ¤¿¤Ï¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¤ÎÁêÂХѥ¹¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
.IR classpathlist
¤Ë¤Ï¡¢Ê£¿ô¤Î¥Ñ¥¹¤Þ¤¿¤Ï jar ¥Õ¥¡¥¤¥ë¤ò´Þ¤á¤ë
¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¤½¤Î¾ì¹ç¡¢³Æ¥Ñ¥¹¤Þ¤¿¤Ï jar ¥Õ¥¡¥¤¥ë¤ò Solaris ¤Ç¤Ï¥³¥í¥ó (\f3:\f1)¤Ç¡¢Windows ¤Ç¤Ï¥»¥ß¥³¥í¥ó (;) ¤Ç¶èÀÚ¤ê¤Þ¤¹¡£
ÌÜŪ¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤Î³«»Ï¥¯¥é¥¹¤¬¤¹¤Ç¤Ë¸¡º÷¥Ñ¥¹Æâ¤Ë¤¢¤ë¾ì¹ç¤Ï¡¢
¤³¤Î¥ª¥×¥·¥ç¥ó¤ÏÉÔÍפǤ¹¡£
.LP
¼¡¤ÎÎã¤Î jar ¥Õ¥¡¥¤¥ë¤Ø¤Î¥Ñ¥¹¤Ë¤Ï¡¢¥É¥Ã¥¯¥ì¥Ã¥È¤Î
³«»Ï¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤¬´Þ¤Þ¤ì¤Æ¤¤¤Þ¤¹¡£
jar ¥Õ¥¡¥¤¥ë̾¤¬´Þ¤Þ¤ì¤Æ¤¤¤ëÅÀ¤ËÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£
.nf
\f3
.fl
\-docletpath /home/user/mifdoclet/lib/mifdoclet.jar
.fl
\fP
.fi
¼¡¤Ï¥É¥Ã¥¯¥ì¥Ã¥È¤Î³«»Ï¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤Î¥Ñ¥¹¤ÎÎã¤Ç¤¹¡£
¥¯¥é¥¹¥Õ¥¡¥¤¥ë̾¤¬¾Êά¤µ¤ì¤Æ¤¤¤ë¤³¤È¤ËÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£
.nf
\f3
.fl
\-docletpath /home/user/mifdoclet/classes/com/sun/tools/doclets/mif/
.fl
\fP
.fi
ÆÃÄê¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤ò¼Â¹Ô¤·¤¿´°Á´¤ÊÎã¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet
¤Î
.na
¡Ö\f2Running the MIF Doclet\fP¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.RE
.LP
.TP
.B \-1.1
¤³¤Îµ¡Ç½¤Ï¡¢javadoc 1.4 ¤«¤éºï½ü¤µ¤ì¤Þ¤·¤¿¡£ÂåÂؤε¡Ç½¤Ï
¸ºß¤·¤Þ¤»¤ó¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢javadoc 1.1 ¤ÇÀ¸À®¤µ¤ì¤ë
¥É¥­¥å¥á¥ó¥È¤Î³°´Ñ¤Èµ¡Ç½ (¥µ¥Ý¡¼¥È¤µ¤ì¤Ê¤¯¤Ê¤Ã¤¿¡¢Æþ¤ì»Ò¤Ë¤Ê¤Ã¤¿¥¯¥é¥¹¤ò
´Þ¤à) ¤òÈ÷¤¨¤¿¥É¥­¥å¥á¥ó¥È¤òºîÀ®¤¹¤ë¤¿¤á¤Î¤â¤Î¤Ç¤·¤¿¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤¬É¬ÍפǤ¢¤ì¤Ð¡¢Âå¤ï
¤ê¤Ë javadoc 1.2 ¤Þ¤¿¤Ï 1.3 ¤ò»ÈÍѤ·¤Æ¤¯¤À¤µ¤¤¡£
.TP 3
\-source release
¼õ¤±ÉÕ¤±¤ë¥½¡¼¥¹¥³¡¼¥É¤Î¥Ð¡¼¥¸¥ç¥ó¤ò»ØÄꤷ¤Þ¤¹¡£\f2release\fP ¤Ë¤Ï¼¡¤ÎÃͤò»ØÄê¤Ç¤­¤Þ¤¹¡£
.LP
.TS
;
l l.
1.5 T{
Javadoc ¤Ï¡¢JDK 1.5 ¤ÇƳÆþ¤µ¤ì¤¿Áí¾Îµ¡Ç½¤ª¤è¤Ó¾¤Î¸À¸ìµ¡Ç½¤ò´Þ¤ó¤À¥³¡¼¥É¤ò¼õ¤±ÉÕ¤±¤Þ¤¹¡£-source ¥Õ¥é¥°¤ò»ØÄꤷ¤Ê¤¤¤È¡¢¥³¥ó¥Ñ¥¤¥é¤Ï¥Ç¥Õ¥©¥ë¥È¤È¤·¤Æ 1.5 ¤ÎÆ°ºî¤ò¤·¤Þ¤¹¡£
T}
1.4 T{
Javadoc ¤Ï¡¢JDK 1.4 ¤ÇƳÆþ¤µ¤ì¤¿¡¢¥¢¥µ¡¼¥·¥ç¥ó¤ò´Þ¤à¥³¡¼¥É¤ò¼õ¤±ÉÕ¤±¤Þ¤¹¡£
T}
1.3 T{
Javadoc ¤Ï¡¢JDK 1.3 °Ê¹ß¤ËƳÆþ¤µ¤ì¤¿¥¢¥µ¡¼¥·¥ç¥ó¡¢Áí¾Îµ¡Ç½¡¢¤Þ¤¿¤Ï¾¤Î¸À¸ìµ¡Ç½¤ò¥µ¥Ý¡¼¥È¤·¤Þ¤»¤ó¡£
T}
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-14
.LP
javac ¤Ç¥³¡¼¥É¤ò¥³¥ó¥Ñ¥¤¥ë¤¹¤ë¤È¤­¤Ë»ÈÍѤ·¤¿ÃͤËÂбþ¤¹¤ë \f2release\fP ¤ÎÃͤò»ÈÍѤ·¤Þ¤¹¡£
.LP
.TP
.BI \-sourcepath " sourcepathlist"
.B javadoc
¥³¥Þ¥ó¥É¤Ë¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Þ¤¿¤Ï \-subpackages
¤òÅϤ¹ºÝ¤Ë¡¢
¥½¡¼¥¹¥Õ¥¡¥¤¥ë (.java) ¸¡º÷ÍѤΥѥ¹¤ò»ØÄꤷ¤Þ¤¹¡£
.BI sourcepathlist
¤Ë¤Ï¡¢¥³¥í¥ó (\f3:\f1)
¤Ç¶èÀڤä¿Ê£¿ô¤Î¥Ñ¥¹¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.B Javadoc
¥Ä¡¼¥ë¤Ï¡¢»ØÄꤵ¤ì¤¿¥Ñ¥¹°Ê²¼¤Î¤¹¤Ù¤Æ¤Î
¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤ò¸¡º÷¤·¤Þ¤¹¡£ ¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»È¤Ã¤Æ¡¢
¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î°ÌÃÖ¤À¤±¤Ç¤Ê¤¯¡¢
¤½¤ì¼«ÂΤϥɥ­¥å¥á¥ó¥È²½¤µ¤ì¤Æ¤¤¤Ê¤¤¤¬¡¢¥É¥­¥å¥á¥ó¥È²½
¤µ¤ì¤Æ¤¤¤ë¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤«¤é·Ñ¾µ¤µ¤ì¤¿¥³¥á¥ó¥È¤ò¤â¤Ä
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î°ÌÃÖ¤â³Îǧ¤Ç¤­¤Þ¤¹¡£
.LP
.B \-sourcepath
¥ª¥×¥·¥ç¥ó¤Ï¡¢
.B javadoc
¥³¥Þ¥ó¥É¤ò»È¤Ã¤Æ¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò»ØÄꤹ¤ë¤È¤­¤Ë¤À¤±»ÈÍѤǤ­¡¢
.B javadoc
¥³¥Þ¥ó¥É¤ËÅϤµ¤ì¤ë
.B .java
¥Õ¥¡¥¤¥ë¤Ï¸¡º÷¤Ç¤­¤Ê¤¤¤³¤È¤ËÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£
.B .java
¥Õ¥¡¥¤¥ë¤ò¸¡º÷¤¹¤ë¤Ë¤Ï¡¢
¤½¤Î¥Ç¥£¥ì¥¯¥È¥ê¤Ë°ÜÆ°¤¹¤ë¤«¡¢
³Æ¥Õ¥¡¥¤¥ë¤ÎÁ°¤Ë¤½¤Î¥Ñ¥¹¤òÉÕ¤±¤Þ¤¹ (¡Ö1 ¤Ä°Ê¾å
¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥É¥­¥å¥á¥ó¥È²½¡×¤ò»²¾È)¡£
.B \-sourcepath
¤¬¾Êά¤µ¤ì¤¿¾ì¹ç¤Ï¡¢
.B javadoc
¤Ï¥¯¥é¥¹¥Ñ¥¹¤ò»È¤Ã¤Æ¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò¸¡º÷¤·¤Þ¤¹ (
.B \-classpath
¤ò»²¾È)¡£ ¤·¤¿¤¬¤Ã¤Æ¡¢
.B \-sourcepath
¤Î¥Ç¥Õ¥©¥ë¥È¤Ï
.B \-classpath
¤ÎÃͤǤ¹¡£
.B -classpath
¤ò¾Êά¤·¤Æ¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò
.BR javadoc
¤ËÅϤ·¤¿¾ì¹ç¡¢
.BR javadoc
¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê (¤ª¤è¤Ó¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê) ¤ò
¸¡º÷¤·¤Þ¤¹¡£
.LP
.RS
.I sourcepathlist
¤Ç¤Ï¡¢¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Î
¥½¡¼¥¹¥Ä¥ê¡¼¤Î¥ë¡¼¥È¥Ç¥£¥ì¥¯¥È¥ê¤ò
ÀßÄꤷ¤Þ¤¹¡£¤¿¤È¤¨¤Ð¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤¬¼¡¤Î
¾ì½ê¤Ë¤¢¤ë
.B com.mypackage
¤È¤¤¤¦Ì¾Á°¤Î¥Ñ¥Ã¥±¡¼¥¸¤ò¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¤È¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
/home/user/src/com/mypackage/*.java
.fi
.ft 1
.RE
.LP
¤³¤Î¾ì¹ç¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Æ¥½¡¼¥¹¥Ñ¥¹¤ò
.BR /home/user/src
¡¢¤Ä¤Þ¤ê
.BR com.mypackage
¤ò´Þ¤à¥Ç¥£¥ì¥¯¥È¥ê¤Ë»ØÄꤷ¡¢¤½¤ì¤«¤é¥Ñ¥Ã¥±¡¼¥¸Ì¾
.BR com.mypackage
¤ò»ØÄꤷ¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-sourcepath /home/user/src/ com.mypackage
.fi
.ft 1
.RE
.LP
¤³¤ì¤Ï¡¢¥½¡¼¥¹¥Ñ¥¹¤ÎÃͤȥѥ屡¼¥¸Ì¾¤ò¤Ä¤Ê¤²¤Æ¡¢
¥É¥Ã¥È¤ò¥¹¥é¥Ã¥·¥å (/) ¤ËÊѤ¨¤ë¤È¡¢°Ê²¼¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥Õ¥ë¥Ñ¥¹
¤Ë¤Ê¤ë¤³¤È¤ËÃíÌܤ¹¤ë¤È³Ð¤¨¤ä¤¹¤¤¤Ç¤·¤ç¤¦¡£
.LP
.RS
.ft 3
.BR /home/user/src/com/mypackage
.RE
.LP
2 ¤Ä¤Î¥½¡¼¥¹¥Ñ¥¹¤ò»ØÄꤹ¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-sourcepath /home/user/src/:/home/user2/src com.mypackage
.fi
.ft 1
.RE
.LP
.RE
.TP
.BI \-classpath " classpathlist"
.B javadoc
¤¬»²¾È¤µ¤ì¤ë¥¯¥é¥¹¤Î¸¡º÷¤ò¹Ô¤¦¥Ñ¥¹¤ò»ØÄꤷ¤Þ¤¹¡£
»²¾È¤µ¤ì¤ë¥¯¥é¥¹ (\f3.class\f1) ¤È¤Ï¡¢
¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹¤È¤½¤ì¤é¤Î¥¯¥é¥¹¤Ë¤è¤Ã¤Æ
»²¾È¤µ¤ì¤ëǤ°Õ¤Î¥¯¥é¥¹¤Î¤³¤È¤Ç¤¹¡£
.B javadoc
¤Ï¡¢»ØÄꤵ¤ì¤¿¥Ñ¥¹°Ê²¼¤Î¤¹¤Ù¤Æ¤Î¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤Ç
¸¡º÷¤ò¹Ô¤¤¤Þ¤¹¡£
.I classpathlist
¤Ë¤Ï¡¢¥Ñ¥¹´Ö¤ò¥³¥í¥ó (\f3:\f1) ¤Ç¶èÀڤäÆÊ£¿ô¤Î¥Ñ¥¹¤ò
´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢»ØÄꤵ¤ì¤¿¥Ñ¥¹°Ê²¼¤Î
¤¹¤Ù¤Æ¤Î¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤ò¸¡º÷¤·¤Þ¤¹¡£
.IR classpathlist
¤Î»ØÄê
¤Ë¤Ä¤¤¤Æ¤Ï¡¢¥¯¥é¥¹¥Ñ¥¹¤Î¥É¥­¥å¥á¥ó¥È¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.RS
.B \-sourcepath
¤ò¾Êά¤·¤¿¾ì¹ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢¥¯¥é¥¹¥Õ¥¡¥¤¥ë (²¼°Ì¸ß´¹ÍÑ) ¤È¤È¤â¤Ë¡¢
.B \-classpath
¤ò»È¤Ã¤Æ¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò¸¡º÷¤·¤Þ¤¹¡£¤³¤Î¤¿¤á¡¢
°Û¤Ê¤ë¥Ñ¥¹Æâ¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ª¤è¤Ó¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤ò¸¡º÷¤¹¤ë¾ì¹ç¤Ï¡¢
.B \-sourcepath
¤È
.BR \-classpath
¤ÎξÊý¤ò»È¤¤¤Þ¤¹¡£
.LP
¤¿¤È¤¨¤Ð¡¢
.BR com.mypackage
¤ò¥É¥­¥å¥á¥ó¥È²½¤·¤¿¤¤¾ì¹ç¤Ë¡¢¥Ñ¥Ã¥±¡¼¥¸¤Î¥¯¥é¥¹¤¬¥Ç¥£¥ì¥¯¥È¥ê
.BR /home/user/src/com/mypackage
¤Ë¤¢¤ê¡¢¤³¤Î¥Ñ¥Ã¥±¡¼¥¸¤¬
.BR /home/user/lib
Æâ¤Î¥é¥¤¥Ö¥é¥ê¤ò»È¤¦¾ì¹ç¤Ï¡¢¼¡¤Î¤è¤¦¤Ë»ØÄꤷ¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-classpath /home/user/lib \-sourcepath /home/user/src com.mypackage
.fi
.ft 1
.RE
.LP
¤Û¤«¤Î¥Ä¡¼¥ë¤ÈƱÍͤˡ¢
.BR \-classpath
¤ò»ØÄꤷ¤Ê¤¤¾ì¹ç¤Ï¡¢CLASSPATH ´Ä¶­ÊÑ¿ô¤¬
ÀßÄꤵ¤ì¤Æ¤¤¤ì¤Ð¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¤³¤Î´Ä¶­ÊÑ¿ô¤ò»È¤¤¤Þ¤¹¡£
¤É¤Á¤é¤âÀßÄꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç
¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¤Ç¥¯¥é¥¹¤ò¸¡º÷¤·¤Þ¤¹¡£
.LP
.B javadoc
¥Ä¡¼¥ë¤¬³ÈÄ¥µ¡Ç½¥¯¥é¥¹¤ª¤è¤Ó¥Ö¡¼¥È¥¹¥È¥é¥Ã¥×¥¯¥é¥¹¤ÈÄÌ¿®¤¹¤ëºÝ¤Ë¡¢
.B -classpath
¤ò»È¤Ã¤Æ¥æ¡¼¥¶¥¯¥é¥¹¤ò¸¡º÷¤¹¤ëÊýË¡¤Ë¤Ä¤¤¤Æ¤Î
¾ÜºÙ¤Ï¡¢¡Ö¥¯¥é¥¹¤Î¸¡º÷ÊýË¡¡×¤ò
»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
Êص¹¾å¡¢\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 ²¾ÁÛ¥Þ¥·¥ó¤Îµ¯Æ°Á°¤Ë¼Â¹Ô¤µ¤ì¤Þ¤¹¡£¤·¤¿¤¬¤Ã¤Æ¡¢\f2System.getenv("CLASSPATH")\fP ¸Æ¤Ó½Ð¤·¤Ê¤É¤Î´Ä¶­¤ËÂФ¹¤ëÌ䤤¹ç¤ï¤»¤ò¹Ô¤ï¤Ê¤¤¸Â¤ê¡¢Å¸³«¤µ¤ì¤Æ¤¤¤Ê¤¤¥ï¥¤¥ë¥É¥«¡¼¥É¤ò Java ¥×¥í¥°¥é¥à¤¬Ç§¼±¤¹¤ë¤³¤È¤Ï¤¢¤ê¤Þ¤»¤ó¡£
.LP
.TP 3
\-subpackages\ \ package1:package2:...
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤«¤é»ØÄꤵ¤ì¤¿¥Ñ¥Ã¥±¡¼¥¸¤ª¤è¤Ó¤½¤Î¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸Æâ¤ËºÆµ¢Åª¤Ë¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¤Þ¤¹¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢¥½¡¼¥¹¥³¡¼¥É¤Ë¿·¤·¤¤¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤òÄɲ乤ëºÝ¤ËÊØÍø¤Ç¤¹¡£¿·¤·¤¤¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤Ï¼«Æ°Åª¤ËÁȤ߹þ¤Þ¤ì¤Þ¤¹¡£³Æ package °ú¿ô¤Ï¡¢Ç¤°Õ¤ÎºÇ¾å°Ì¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸ (java ¤Ê¤É) ¤Þ¤¿¤Ï´°Á´»ØÄê¤Î¥Ñ¥Ã¥±¡¼¥¸ (javax.swing ¤Ê¤É) ¤Ë¤Ê¤ê¤Þ¤¹¡£¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò´Þ¤á¤ëɬÍפϤ¢¤ê¤Þ¤»¤ó¡£°ú¿ô¤Ï¡¢¥³¥í¥ó¤Ç¶èÀÚ¤é¤ì¤Þ¤¹ (¤¹¤Ù¤Æ¤Î¥ª¥Ú¥ì¡¼¥Æ¥£¥ó¥°¥·¥¹¥Æ¥à)¡£¥ï¥¤¥ë¥É¥«¡¼¥É¤ÏÉÔÍפǤ¹ (»ÈÍÑÉÔ²Ä)¡£¥Ñ¥Ã¥±¡¼¥¸¤Î¸¡º÷¾ì½ê¤ò»ØÄꤹ¤ë¤Ë¤Ï¡¢\-sourcepath ¤ò»ÈÍѤ·¤Þ¤¹¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢¡Ö¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î½èÍý¡×¤ÇÀâÌÀ¤·¤¿¤È¤ª¤ê¡¢¥½¡¼¥¹¥Ä¥ê¡¼¤Ë¤¢¤ë¤¬¥Ñ¥Ã¥±¡¼¥¸¤Ë¤Ï°¤·¤Æ¤¤¤Ê¤¤¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò½èÍý¤·¤Ê¤¤¤Î¤ÇÌòΩ¤Á¤Þ¤¹¡£
.LP
¼¡¤ËÎã¤ò¼¨¤·¤Þ¤¹¡£
.nf
\f3
.fl
% \fP\f3javadoc \-d docs \-sourcepath /home/user/src \-subpackages java:javax.swing\fP
.fl
.fi
¤³¤Î¥³¥Þ¥ó¥É¤Ï¡¢¡Öjava¡×¤ª¤è¤Ó¡Öjavax.swing¡×¤È¤¤¤¦Ì¾Á°¤Î¥Ñ¥Ã¥±¡¼¥¸¤È¤³¤ì¤é¤Î¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸Á´Éô¤Î¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¤Þ¤¹¡£
.LP
\f2\-exclude\fP ¤È¤È¤â¤Ë \f2\-subpackages\fP ¤ò»ÈÍѤ¹¤ë¤È¡¢ÆÃÄê¤Î¥Ñ¥Ã¥±¡¼¥¸¤ò½ü³°¤Ç¤­¤Þ¤¹¡£
.LP
.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 ¤Ï½ü³°¤µ¤ì¤Þ¤¹¡£
.RE
.TP
.BI \-bootclasspath " classpathlist"
¥Ö¡¼¥È¥¯¥é¥¹¤¬Â¸ºß¤¹¤ë¥Ñ¥¹¤ò»ØÄꤷ¤Þ¤¹¡£
¥Ö¡¼¥È¥¯¥é¥¹¤È¤Ï¡¢Java ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à¥¯¥é¥¹¤Î¤³¤È¤Ç¤¹¡£
.B bootclasspath
¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤¬¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤È¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤òõ¤¹¤È¤­¤Ë
»È¤¦¸¡º÷¥Ñ¥¹¤Î°ìÉô¤Ç¤¹¡£¾ÜºÙ¤Ï¡¢
¡ÖJavac ¤È Javadoc ¤¬¥¯¥é¥¹¤ò¸¡º÷¤¹¤ëÊýË¡¡× ¤ò
»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.I classpathlist
Æâ¤ÎÊ£¿ô¤Î
¥¯¥é¥¹¥Ñ¥¹¥ê¥¹¥È¤Ï¡¢¥³¥í¥ó (:) ¤Ç¶èÀÚ¤ê¤Þ¤¹¡£
.TP
.BI \-extdirs " dirlist"
³ÈÄ¥µ¡Ç½¥¯¥é¥¹¤¬Â¸ºß¤¹¤ë¥Ç¥£¥ì¥¯¥È¥ê¤ò»ØÄꤷ¤Þ¤¹¡£
³ÈÄ¥µ¡Ç½¥¯¥é¥¹¤Ï¡¢Java ³ÈÄ¥µ¡Ç½
µ¡¹½¤ò»È¤¦¤¹¤Ù¤Æ¤Î¥¯¥é¥¹¤Ç¤¹¡£³ÈÄ¥µ¡Ç½¥Ç¥£¥ì¥¯¥È¥ê (
.B extdirs
) ¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤¬¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤È¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤òõ¤¹¤È¤­¤Ë»È¤¦¸¡º÷¥Ñ¥¹¤Î°ìÉô¤Ç¤¹¡£
¾ÜºÙ¤Ï¡¢¾å¤Î
.B \-classpath
¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.I dirlist
Æâ¤ÎÊ£¿ô¤Î¥Ç¥£¥ì¥¯¥È¥ê¤Ï¡¢
¥³¥í¥ó (:) ¤Ç¶èÀÚ¤ê¤Þ¤¹¡£
.TP
.B \-verbose
.B javadoc
¤Î¼Â¹ÔÃæ¤Ë¾ÜºÙ¤Ê¥á¥Ã¥»¡¼¥¸¤òɽ¼¨¤·¤Þ¤¹¡£¾éĹ¥ª¥×¥·¥ç¥ó¤ò
»ØÄꤷ¤Ê¤¤¾ì¹ç¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¥í¡¼¥É»þ¡¢¥É¥­¥å¥á¥ó¥È¤Î
À¸À®»þ (¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤´¤È¤Ë 1 ¤Ä¤Î¥á¥Ã¥»¡¼¥¸)¡¢¤ª¤è¤Ó¥½¡¼¥È»þ¤Ë
¥á¥Ã¥»¡¼¥¸¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£¾éĹ¥ª¥×¥·¥ç¥ó¤ò»ØÄꤷ¤¿¾ì¹ç¤Ï¡¢
³Æ java ¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î²òÀϤËÍפ·¤¿¥ß¥êÉÿô¤Ê¤É¤Î
Äɲåá¥Ã¥»¡¼¥¸¤òɽ¼¨¤·¤Þ¤¹¡£
.TP
.BI \-quiet
¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸°Ê³°¡¢¤ª¤è¤Ó·Ù¹ð¥á¥Ã¥»¡¼¥¸°Ê³°¤Î
¥á¥Ã¥»¡¼¥¸¤ò½ü³°¤·¡¢
¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤ª¤è¤Ó·Ù¹ð¥á¥Ã¥»¡¼¥¸¤À¤±¤ò
ɽ¼¨¤·¤Æ¸«¤Ä¤±¤ä¤¹¤¯¤·¤Þ¤¹¡£
¤Þ¤¿¡¢¥Ð¡¼¥¸¥ç¥óʸ»úÎó¤Îɽ¼¨¤âÍÞÀ©¤·¤Þ¤¹¡£
.LP
.TP 3
\-breakiterator\
±Ñ¸ì¸À¸ì¤È¤¤¤¦¥í¥±¡¼¥ë¸ÇÍ­¤Î¥¢¥ë¥´¥ê¥º¥à¤Ç¤Ï¤Ê¤¯¡¢\f2java.text.BreakIterator\fP ¤Î¹ñºÝ²½¤µ¤ì¤¿Ê¸¶­³¦¤ò»ÈÍѤ·¤Æ¡¢±Ñʸ¤ÎºÇ½é¤Îʸ¤Î½ª¤ï¤ê¤òȽÃǤ·¤Þ¤¹ (¾¤Î¤¹¤Ù¤Æ¤Î¥í¥±¡¼¥ë¤Ï¤¹¤Ç¤Ë \f2BreakIterator\fP ¤ò»ÈÍÑ)¡£¡Ö\f2ºÇ½é¤Îʸ\fP¡×¤È¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¤Þ¤¿¤Ï¥á¥ó¥Ð¤Î¼çÀâÌÀ¤Ç¤ÎºÇ½é¤Îʸ¤Î¤³¤È¤Ç¤¹¡£¤³¤Îʸ¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¤Þ¤¿¤Ï¥á¥ó¥Ð¤ÎÍ×Ìó¤Ë¥³¥Ô¡¼¤µ¤ì¡¢¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È½ç¤Î¥¤¥ó¥Ç¥Ã¥¯¥¹¤Ë¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£
.LP
JDK 1.2 °Ê¹ß¡¢BreakIterator ¥¯¥é¥¹¤Ï¡¢±Ñ¸ì¤ò½ü¤¯¤¹¤Ù¤Æ¤Î¸À¸ì¤Îʸ¤Î½ª¤ï¤ê¤òȽÃǤ¹¤ë¤¿¤á¤Ë¡¢¤¹¤Ç¤Ë»ÈÍѤµ¤ì¤Æ¤¤¤Þ¤¹¡£¤·¤¿¤¬¤Ã¤Æ¡¢1.2 °Ê¹ß¤Ç¤Ï¡¢\f2\-breakiterator\fP ¥ª¥×¥·¥ç¥ó¤Ï±Ñʸ°Ê³°¤Ë¤Ï¸ú²Ì¤¬¤¢¤ê¤Þ¤»¤ó¡£±Ñʸ¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤ÊÆȼ«¤Î¥Ç¥Õ¥©¥ë¥È¤Î¥¢¥ë¥´¥ê¥º¥à¤¬¤¢¤ê¤Þ¤¹¡£
.RS 3
.TP 2
o
±Ñʸ¤Î¥Ç¥Õ¥©¥ë¥È¤Îʸ¶èÀڤꥢ¥ë¥´¥ê¥º¥à \- ¶õÇò¤Þ¤¿¤Ï HTML ¥Ö¥í¥Ã¥¯¥¿¥° (\f2<P>\fP ¤Ê¤É) ¤¬Â³¤¯¥Ô¥ê¥ª¥É¤ÇÄä»ß¤¹¤ë
.TP 2
o
breakiterator ʸ¶èÀڤꥢ¥ë¥´¥ê¥º¥à \- °ìÈ̤ˡ¢¼¡¤Î¸ì¤¬Âçʸ»ú¤Ç»Ï¤Þ¤ë¾ì¹ç¡¢¶õÇòʸ»ú¤¬Â³¤¯¥Ô¥ê¥ª¥É¡¢µ¿ÌäÉä¡¢¤Þ¤¿¤Ï´¶Ã²Éä¤ÇÄä»ß¤¹¤ë¡£¤³¤Î¥¢¥ë¥´¥ê¥º¥à¤Ç¤Ï¡¢¤Û¤È¤ó¤É¤Î¾Êάɽµ­¤¬½èÍý¤µ¤ì¤ë (¡ÖThe serial no. is valid¡×¤Ï½èÍý¤µ¤ì¤ë¤¬¡ÖMr. Smith¡×¤Ï½èÍý¤µ¤ì¤Ê¤¤)¡£HTML ¥¿¥°¤ä¡¢¿ô»ú¤Þ¤¿¤Ïµ­¹æ¤Ç»Ï¤Þ¤ëʸ¤Ç¤ÏÄä»ß¤·¤Ê¤¤¡£HTML ¥¿¥°¤ËËä¤á¹þ¤Þ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ç¤â¡¢¡Ö../filename¡×¤ÎºÇ¸å¤Î¥Ô¥ê¥ª¥É¤ÇÄä»ß¤¹¤ë
.RE
.RS 3
.LP
.LP
Ãí: 1.5.0 ¤«¤é¤Ï¡¢1.4.x ¤ËÀߤ±¤é¤ì¤Æ¤¤¤¿ breakiterator ·Ù¹ð¥á¥Ã¥»¡¼¥¸¤òºï½ü¤·¡¢¥Ç¥Õ¥©¥ë¥È¤Îʸ¶èÀڤꥢ¥ë¥´¥ê¥º¥à¤òÊѹ¹¤·¤Æ¤¤¤Þ¤»¤ó¡£¤Ä¤Þ¤ê¡¢\-breakiterator ¥ª¥×¥·¥ç¥ó¤Ï¡¢1.5.0 ¤Ç¤Ï¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¤Ê¤¯¤Ê¤ê¡¢¤Þ¤¿¥Ç¥Õ¥©¥ë¥È¤Ë¤¹¤ë¤Ä¤â¤ê¤â¤¢¤ê¤Þ¤»¤ó¡£¤³¤ì¤Ï¡¢¡Ö¼¡¤Î¥á¥¸¥ã¡¼¥ê¥ê¡¼¥¹¡×(1.5.0) ¤Ç¥Ç¥Õ¥©¥ë¥È¤òÊѹ¹¤¹¤ë¤È¤¤¤¦¡¢°ÊÁ°¤ÎÌÜŪ¤È¤ÏµÕ¤Ë¤Ê¤Ã¤Æ¤¤¤Þ¤¹¡£¤Ä¤Þ¤ê¡¢¥½¡¼¥¹¥³¡¼¥É¤òÊѹ¹¤»¤º¡¢1.4.x ¤Ç¤Î breakiterator ·Ù¹ð¤ò½üµî¤·¤Æ¤¤¤Ê¤¤¾ì¹ç¤Ç¤â¡¢1.5.0 ¤«¤é¤Ï²¿¤â¤¹¤ëɬÍפ¬¤Ê¤¯¡¢·Ù¹ð¤Ï¾ÃÌǤ·¤Æ¤¤¤Þ¤¹¡£¤³¤ÎµÕÌá¤ê¤ÎÍýͳ¤Ï¡¢breakiterator ¤ò¥Ç¥Õ¥©¥ë¥È¤Ë¤¹¤ë¥á¥ê¥Ã¥È¤è¤ê¤â¡¢¥Ç¥Õ¥©¥ë¥È¤Ë¤¹¤ë¤¿¤á¤ËɬÍפȤʤ롢¸ß´¹À­¤Î¤Ê¤¤¥½¡¼¥¹¤ÎÊѹ¹¤ÎÊý¤¬Ééô¤¬Â礭¤«¤Ã¤¿¤¿¤á¤Ç¤¹¡£¤³¤ì¤ËÈñ¤ä¤·¤¿ºî¶È¤äº®Íð¤¬ÌµÂ̤ˤʤê»ÄÇ°¤Ç¤¹¡£
.LP
.TP
.BI \-locale " language_country_variant"
.B ½ÅÍ×:
\-locale ¥ª¥×¥·¥ç¥ó¤Ï¡¢É¸½à¥É¥Ã¥¯¥ì¥Ã¥È¤ä¤½¤Î¾¤Î¥É¥Ã¥¯¥ì¥Ã¥È
¤Ë¤è¤Ã¤ÆÄ󶡤µ¤ì¤ë¥ª¥×¥·¥ç¥ó¤è¤ê¤âÁ°¤Ë (º¸Â¦¤Ë)
»ØÄꤹ¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£¤½¤¦¤Ç¤Ê¤±¤ì¤Ð¡¢¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Ï
±Ñ¸ì¤Çɽ¼¨¤µ¤ì¤Þ¤¹¡£½ç½ø¤Ë°Í¸¤¹¤ë¥³¥Þ¥ó¥É¹Ô¥ª¥×¥·¥ç¥ó¤Ï¡¢
¤³¤Î¥ª¥×¥·¥ç¥ó¤Î¤ß¤Ç¤¹¡£
.LP
.RS
.B javadoc
¤¬¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤¹¤ë¤È¤­¤Ë»È¤¦¥í¥±¡¼¥ë¤ò»ØÄꤷ¤Þ¤¹¡£
°ú¿ô¤Ë¤Ï¡¢java.util.Locale ¤Î¥É¥­¥å¥á¥ó¥È¤ÇÀâÌÀ¤µ¤ì¤Æ¤¤¤ë
¥í¥±¡¼¥ë¤ò»ØÄꤷ¤Þ¤¹¡£
¤¿¤È¤¨¤Ð¡¢en_US (±Ñ¸ì¡¢Êƹñ)¡¢en_US_WIN (Windows ¤Ç»È¤ï¤ì¤ë±Ñ¸ì) ¤Ê¤É¤ò
»ØÄꤷ¤Þ¤¹¡£
.LP
¥í¥±¡¼¥ë¤ò»ØÄꤹ¤ë¤È¡¢
.B javadoc
¤Ï»ØÄꤵ¤ì¤¿¥í¥±¡¼¥ë¤Î¥ê¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤òÁªÂò¤·¤Æ
¥á¥Ã¥»¡¼¥¸ (¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¡¢¥ê¥¹¥È¤Èɽ¤Î¸«½Ð¤·¡¢
¥Ø¥ë¥×¥Õ¥¡¥¤¥ë¤ÎÌܼ¡¡¢
.BR stylesheet.css
¤Î¥³¥á¥ó¥È¤Ê¤É¤Îʸ»úÎó) ¤Ë
»È¤¤¤Þ¤¹¡£¤Þ¤¿¡¢¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È½ç¤Ë¥½¡¼¥È¤µ¤ì¤ë¥ê¥¹¥È¤Î¥½¡¼¥È½ç¡¢
¤ª¤è¤ÓºÇ½é¤Îʸ¤ÎËöÈø¤ò·èÄꤹ¤ëʸ¤Î¶èÀÚ¤êʸ»ú¤â¡¢
»ØÄꤷ¤¿¥í¥±¡¼¥ë¤Ë¤è¤Ã¤Æ·è¤Þ¤ê¤Þ¤¹¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢
¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ëÆâ¤Ç
»ØÄꤵ¤ì¤Æ¤¤¤ë doc ¥³¥á¥ó¥È¥Æ¥­¥¹¥È¤Î
¥í¥±¡¼¥ë¤ò·èÄꤹ¤ë¤â¤Î¤Ç¤Ï¤¢¤ê¤Þ¤»¤ó¡£
.RE
.TP
.BI \-encoding " name"
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°Ì¾ (EUCJIS/SJIS ¤Ê¤É) ¤ò»ØÄꤷ¤Þ¤¹¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤¬»ØÄꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¤Ï¡¢¥×¥é¥Ã¥È¥Õ¥©¡¼¥à¤Î
¥Ç¥Õ¥©¥ë¥È¥³¥ó¥Ð¡¼¥¿¤¬»È¤ï¤ì¤Þ¤¹¡£
.LP
\-docencoding ¤ª¤è¤Ó \-charset ¤â»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP
.BI \-J flag
.BR javadoc
¤ò¼Â¹Ô¤¹¤ë¼Â¹Ô¥·¥¹¥Æ¥à java ¤Ë flag ¤òľÀÜÅϤ·¤Þ¤¹¡£J ¤È flag ¤Î´Ö¤Ë
¶õÇò¤òÆþ¤ì¤Æ¤Ï¤Ê¤ê¤Þ¤»¤ó¡£¤¿¤È¤¨¤Ð¡¢À¸À®¤µ¤ì¤ë
¥É¥­¥å¥á¥ó¥È¤ò½èÍý¤¹¤ë¤¿¤á¤Ë¡¢¥·¥¹¥Æ¥à¤Ç 32M ¥Ð¥¤¥È¤ò
³ÎÊݤ¹¤ëɬÍפ¬¤¢¤ë¾ì¹ç¤Ï¡¢Java ¤Î
.B \-Xmx
¥ª¥×¥·¥ç¥ó¤ò¼¡¤Î¤è¤¦¤Ë¸Æ¤Ó½Ð¤·¤Þ¤¹¡£\-Xms ¤Ï¥ª¥×¥·¥ç¥ó¤Ç¤¹¡£½é´ü¥á¥â¥ê¤Î¥µ¥¤¥º¤Î¤ß¤òÀßÄꤹ¤ë¤¿¤á¡¢É¬ÍפʺǾ®¥á¥â¥ê¤òÃΤäƤ¤¤ë¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-J\-Xmx32m \-J\-Xms32m com.mypackage
.fi
.ft 1
.RE
.LP
»ÈÍѤ·¤Æ¤¤¤ë javadoc ¤Î¥Ð¡¼¥¸¥ç¥ó¤ò³Îǧ¤¹¤ë¤Ë¤Ï¡¢
¼¡¤Î¤è¤¦¤Ë java ¤Î¡Ö-version¡×¥ª¥×¥·¥ç¥ó¤ò¸Æ¤Ó½Ð¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc -J-version
java version "1.2"
Classic VM (build JDK-1.2-V, green threads, sunwjit)
.fi
.ft 1
.RE
.LP
(ɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤Î¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤Ï½ÐÎÏ¥¹¥È¥ê¡¼¥à¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£)
.SS "ɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤¬Ä󶡤¹¤ë¥ª¥×¥·¥ç¥ó"
.TP
.BI \-d " directory"
À¸À®¤µ¤ì¤¿ HTML ¥Õ¥¡¥¤¥ë¤òÊݸ¤¹¤ë¥Ç¥£¥ì¥¯¥È¥ê¤ò
»ØÄꤷ¤Þ¤¹ (d ¤Ï¡ÖÀ¸À®Àè (destination)¡×¤Î°ÕÌ£)¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤ò
¾Êά¤¹¤ë¤È¡¢À¸À®¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤Ï¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¤ËÊݸ¤µ¤ì¤Þ¤¹¡£
ÃÍ
.I directory
¤Ë¤Ï¡¢ÀäÂХǥ£¥ì¥¯¥È¥ê¤Þ¤¿¤Ï¸½ºß¤Îºî¶È
¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¤ÎÁêÂХǥ£¥ì¥¯¥È¥ê¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
1.4 ¤Ç¤Ï¡¢javadoc ¤Î¼Â¹Ô»þ¤Ë
¼«Æ°Åª¤ËÀ¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê¤¬ºîÀ®¤µ¤ì¤Þ¤¹¡£
.LP
¤¿¤È¤¨¤Ð¡¢
¼¡¤ÎÎã¤Ï¡¢com.mypackage ¥Ñ¥Ã¥±¡¼¥¸¤Î¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¡¢
·ë²Ì¤ò
.B /home/user/doc/
¥Ç¥£¥ì¥¯¥È¥ê¤ËÊݸ¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/user/doc com.mypackage
.fi
.ft 1
.RE
.TP
.B \-use
¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹¤È¥Ñ¥Ã¥±¡¼¥¸¤´¤È¤Ë 1 ¤Ä¤Î [»ÈÍÑ] ¥Ú¡¼¥¸¤ò
´Þ¤á¤Þ¤¹¡£¤³¤Î¥Ú¡¼¥¸¤Ë¤Ï¡¢¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥¯¥é¥¹¤Þ¤¿¤Ï
¥Ñ¥Ã¥±¡¼¥¸¤Î API ¤ò»È¤Ã¤Æ¤¤¤ë¥Ñ¥Ã¥±¡¼¥¸¡¢¥¯¥é¥¹¡¢¥á¥½¥Ã¥É¡¢
¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¤ª¤è¤Ó¥Õ¥£¡¼¥ë¥É¤¬µ­½Ò¤µ¤ì¤Þ¤¹¡£¤¿¤È¤¨¤Ð¡¢¥¯¥é¥¹
C ¤ª¤è¤Ó¥¯¥é¥¹ C ¤ò»È¤¦¤â¤Î¤Ï¡¢C ¤Î¥µ¥Ö¥¯¥é¥¹¡¢C ¤È¤·¤Æ
Àë¸À¤µ¤ì¤Æ¤¤¤ë¥Õ¥£¡¼¥ë¥É¡¢C ¤òÊÖ¤¹¥á¥½¥Ã¥É¡¢¤ª¤è¤Ó¡¢·¿ C ¤Î
¥Ñ¥é¥á¡¼¥¿¤ò»ý¤Ä¥á¥½¥Ã¥É¤È¥³¥ó¥¹¥È¥é¥¯¥¿¤¬¥Ú¡¼¥¸¤Ë´Þ¤Þ
¤ì¤Þ¤¹¡£
.LP
.RS
¤¿¤È¤¨¤Ð¡¢String ¤Ë¤Ä¤¤¤Æ¡¢[»ÈÍÑ] ¥Ú¡¼¥¸¤Ë²¿¤¬É½¼¨¤µ¤ì¤ë¤«¤ò
¸«¤Æ¤ß¤Þ¤·¤ç¤¦¡£
.B java.awt.Font
¥¯¥é¥¹¤Î
.B getName()
¥á¥½¥Ã¥É¤Ï¡¢String ·¿¤òÊÖ¤·¤Þ¤¹¡£
¤³¤Î¤¿¤á¡¢
.B getName()
¤Ï String ¤ò»È¤¦¤Î¤Ç¡¢[»ÈÍÑ] ¥Ú¡¼¥¸¤Î String ¤Ç
¤³¤Î¥á¥½¥Ã¥É¤ò¸«¤Ä¤±¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
¤³¤Î¥Ú¡¼¥¸¤Ç¤Ï API ¤Î»ÈÍѤÀ¤±¤¬¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¡¢¼ÂÁõ¤Ï¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤Þ¤»¤ó¡£
¤¢¤ë¥á¥½¥Ã¥É¤¬¼ÂÁõÆâ¤Ë String ¤ò»È¤Ã¤Æ¤¤¤ë¤¬¡¢°ú¿ô¤È¤·¤Æ
ʸ»úÎó¤ò¤È¤Ã¤¿¤ê¡¢Ê¸»úÎó¤òÊÖ¤·¤¿¤ê¤·¤Ê¤¤
¾ì¹ç¤Ï¡¢String ¤Î¡Ö»ÈÍѡפȤϤߤʤµ¤ì¤Þ¤»¤ó¡£
.LP
À¸À®¤µ¤ì¤¿ [»ÈÍÑ] ¥Ú¡¼¥¸¤Ë¥¢¥¯¥»¥¹¤¹¤ë¤Ë¤Ï¡¢ÌÜŪ¤Î¥¯¥é¥¹¤Þ¤¿¤Ï
¥Ñ¥Ã¥±¡¼¥¸¤òɽ¼¨¤·¤Æ¡¢¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Î [»ÈÍÑ] ¥ê¥ó¥¯¤ò
¥¯¥ê¥Ã¥¯¤·¤Þ¤¹¡£
.RE
.TP
.B \-version
À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤Ë
.B @version
¥Æ¥­¥¹¥È¤ò´Þ¤á¤Þ¤¹¡£¤³¤Î¥Æ¥­¥¹¥È¤Ï¡¢¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¾Êά¤µ¤ì¤Þ¤¹¡£
»ÈÍѤ·¤Æ¤¤¤ë javadoc ¥Ä¡¼¥ë¤Î¥Ð¡¼¥¸¥ç¥ó¤ò³Îǧ¤¹¤ë¤Ë¤Ï¡¢
.B \-J\-version
¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Þ¤¹¡£
.TP
.B \-author
À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤Ë
.B @author
¥Æ¥­¥¹¥È¤ò´Þ¤á¤Þ¤¹¡£
.TP
.B \-splitindex
º÷°ú¥Õ¥¡¥¤¥ë¤ò¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È¤´¤È¤ËÊ£¿ô¤Î¥Õ¥¡¥¤¥ë¤Ëʬ³ä¤·¡¢
ʸ»ú¤´¤È¤Ë 1 ¤Ä¤Î¥Õ¥¡¥¤¥ë¤È¡¢¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È°Ê³°¤Îʸ»ú¤Ç»Ï¤Þ¤ë
º÷°ú¥¨¥ó¥È¥êÍѤΥե¡¥¤¥ë¤ò 1 ¤ÄºîÀ®¤·¤Þ¤¹¡£
.TP
.BI \-windowtitle " title"
HTML ¤Î
.B <title>
¥¿¥°¤Ç»È¤¦¥¿¥¤¥È¥ë¤ò»ØÄꤷ¤Þ¤¹¡£»ØÄꤷ¤¿¥¿¥¤¥È¥ë¤Ï¡¢
¥¦¥£¥ó¥É¥¦¥¿¥¤¥È¥ë¤È¡¢³ºÅö¤¹¤ë¥Ú¡¼¥¸¤ËÂФ·¤ÆºîÀ®¤µ¤ì¤¿¥Ö¥é¥¦¥¶¤Î
¥Ö¥Ã¥¯¥Þ¡¼¥¯ (¤è¤¯¥¢¥¯¥»¥¹¤¹¤ë¾ì½ê) ¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£
¥¿¥¤¥È¥ë¤Ë¤Ï HTML ¥¿¥°¤ò´Þ¤á¤Ê¤¤¤Ç¤¯¤À¤µ¤¤¡£¥¿¥¤¥È¥ë¤Ë HTML ¥¿¥°¤¬
´Þ¤Þ¤ì¤Æ¤¤¤ë¤È¡¢¥Ö¥é¥¦¥¶¤Ë¤è¤ë¥¿¥°¤Î²ò¼á¤¬ÉÔŬÀڤˤʤë
²ÄǽÀ­¤¬¤¢¤ê¤Þ¤¹¡£
.I title
¤ÎÃæ¤Ç°úÍÑÉä¤ò»È¤¦¾ì¹ç¤Ï¡¢°úÍÑÉä¤ò
¥¨¥¹¥±¡¼¥×¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.B -windowtitle
¤¬¾Êά¤µ¤ì¤Æ¤¤¤ë¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¤³¤Î¥ª¥×¥·¥ç¥ó¤ÎÂå¤ï¤ê¤Ë -doctitle ¤ÎÃͤò»È¤¤¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc -windowtitle "Java 2 Platform" com.mypackage
.fi
.ft 1
.RE
.TP
.BI \-doctitle " title"
³µÍ×¥Õ¥¡¥¤¥ë¤ÎºÇ¾åÉô¶á¤¯¤ËÇÛÃÖ¤¹¤ë¥¿¥¤¥È¥ë¤ò»ØÄꤷ¤Þ¤¹¡£
¥¿¥¤¥È¥ë¤ÏÃæ±û·¤¨¤µ¤ì¡¢¥ì¥Ù¥ë 1 ¤Î¸«½Ð¤·¤È¤·¤Æ¾åÉô
¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Î¤¹¤°²¼¤ËÃÖ¤«¤ì¤Þ¤¹¡£
.I title
¤Ë¤Ï¡¢HTML ¥¿¥°¤È
¶õÇò¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¤¬¡¢¤³¤ì¤é¤ò´Þ¤á¤ë¾ì¹ç¤ÏÁ´ÂΤò°úÍÑÉä¤Ç°Ï
¤Þ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
.I title
¤ÎÃæ¤Ç°úÍÑÉä¤ò»È¤¦¾ì¹ç¤Ï¡¢°úÍÑÉä¤ò¥¨¥¹¥±¡¼¥×¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc -doctitle "Java<sup><font size=\"-2\">TM</font></sup>" com.mypackage
.fi
.ft 1
.RE
.TP
.BI \-title " title"
¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢¸½ºß¤Ï¸ºß¤·¤Þ¤»¤ó¡£
.B javadoc
1.2 ¤Î¥Ù¡¼¥¿ÈǤˤÀ¤±Â¸ºß¤·¤Þ¤·¤¿¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢
¥¦¥£¥ó¥É¥¦¥¿¥¤¥È¥ë¤Ç¤Ï¤Ê¤¯¥É¥­¥å¥á¥ó¥È¥¿¥¤¥È¥ë¤òÄêµÁ¤¹¤ë¤³¤È¤ò
ÌÀ³Î¤Ë¤¹¤ë¤¿¤á¡¢
.BR \-doctitle
¤Ë̾Á°¤¬Êѹ¹¤µ¤ì¤Þ¤·¤¿¡£
.TP
.BI \-header " header"
³Æ½ÐÎÏ¥Õ¥¡¥¤¥ë¤Î¾åÉô¤ËÇÛÃÖ¤¹¤ë¥Ø¥Ã¥À¥Æ¥­¥¹¥È¤ò»ØÄꤷ¤Þ¤¹¡£¥Ø¥Ã¥À¤Ï¡¢
¾åÉô¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Î±¦Â¦¤ËÇÛÃÖ¤µ¤ì¤Þ¤¹¡£
.I header
¤Ë¤Ï¡¢HTML ¥¿¥°¤È
¶õÇò¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¤¬¡¢¤³¤ì¤é¤ò´Þ¤á¤ë¾ì¹ç¤ÏÁ´ÂΤò°úÍÑÉä¤Ç
°Ï¤Þ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£header ¤ÎÃæ¤Ç°úÍÑÉä¤ò»È¤¦¾ì¹ç¤Ï¡¢°úÍÑÉä¤ò
¥¨¥¹¥±¡¼¥×¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.nf
\f3
.fl
% \fP\f3javadoc \-header "<b>Java 2 Platform </b><br>v1.4" com.mypackage\fP
.fl
.fi
.LP
.TP
.BI \-footer " footer"
³Æ½ÐÎÏ¥Õ¥¡¥¤¥ë¤Î²¼Éô¤ËÇÛÃÖ¤¹¤ë¥Õ¥Ã¥¿¥Æ¥­¥¹¥È¤ò»ØÄꤷ¤Þ¤¹¡£¥Õ¥Ã¥¿¤Ï¡¢
²¼Éô¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Î±¦Â¦¤ËÇÛÃÖ¤µ¤ì¤Þ¤¹¡£
.I footer
¤Ë¤Ï¡¢HTML ¥¿¥°¤È
¶õÇò¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¤¬¡¢¤³¤ì¤é¤ò´Þ¤á¤ë¾ì¹ç¤ÏÁ´ÂΤò°úÍÑÉä¤Ç
°Ï¤Þ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
.I footer
¤ÎÃæ¤Ç°úÍÑÉä¤ò»È¤¦¾ì¹ç¤Ï¡¢°úÍÑÉä¤ò¥¨¥¹¥±¡¼¥×¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.TP
.BI \-bottom " text"
³Æ½ÐÎÏ¥Õ¥¡¥¤¥ë¤ÎºÇ²¼Éô¤ËÇÛÃÖ¤¹¤ë¥Æ¥­¥¹¥È¤ò»ØÄꤷ¤Þ¤¹¡£
¤³¤Î¥Æ¥­¥¹¥È¤Ï¡¢²¼Éô¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Î²¼¤Î¥Ú¡¼¥¸¤ÎºÇ²¼Éô¤Ë
ÇÛÃÖ¤µ¤ì¤Þ¤¹¡£
.I text
¤Ë¤Ï¡¢HTML ¥¿¥°¤È¶õÇò¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¤¬¡¢
¤³¤ì¤é¤ò´Þ¤á¤ë¾ì¹ç¤ÏÁ´ÂΤò°úÍÑÉä¤Ç°Ï¤Þ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
.I text
¤ÎÃæ¤Ç°úÍÑÉä¤ò»È¤¦¾ì¹ç¤Ï¡¢°úÍÑÉä¤ò¥¨¥¹¥±¡¼¥×¤¹¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.TP
.BI \-link " extdocURL"
.B javadoc
¥Ä¡¼¥ë¤Ë¤è¤êÀ¸À®¤µ¤ì¤¿´û¸¤Î
³°Éô»²¾È¥¯¥é¥¹¤Î¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¤Ø¤Î¥ê¥ó¥¯¤òºîÀ®¤·¤Þ¤¹¡£
°ú¿ô¤Ï 1 ¤Ä¤Ç¤¹¡£
.TP
\(bu
.I extdocURL
¤Ï¡¢javadoc ¤Ë¤è¤Ã¤ÆÀ¸À®¤µ¤ì¡¢¥ê¥ó¥¯Àè¤È¤·¤Æ»ØÄꤹ¤ë
³°Éô¥É¥­¥å¥á¥ó¥È¤¬¤¢¤ë¥Ç¥£¥ì¥¯¥È¥ê¤ÎÀäÂÐ URL ¤Þ¤¿¤ÏÁêÂÐ URL ¤Ç¤¹¡£ ¤¢¤È¤ÇÎã¤ò¼¨¤·¤Þ¤¹¡£ ¤³¤Î¥Ç¥£¥ì¥¯¥È¥êÆâ¤Ë package-list ¥Õ¥¡¥¤¥ë¤¬Â¸ºß¤·¤Æ
¤¤¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£Â¸ºß¤·¤Ê¤¤¾ì¹ç¤Ï¡¢\-linkoffline ¤ò»ÈÍѤ·¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï package-list ¥Õ¥¡¥¤¥ë¤«¤é¥Ñ¥Ã¥±¡¼¥¸Ì¾¤òÆɤ߼è¤ê¡¢¤½¤ì¤ò
.I extdocURL
¤Î¥Ñ¥Ã¥±¡¼¥¸¤Ë¥ê¥ó¥¯¤·¤Þ¤¹¡£ javadoc ¥Ä¡¼¥ë¤ò¼Â¹Ô¤¹¤ë¤È¡¢
.I extdocURL
ÃͤϺîÀ®¤µ¤ì¤¿ <A HREF> ¥ê¥ó¥¯¤Ë¤½¤Î¤Þ¤Þ¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£ ¤·¤¿¤¬¤Ã¤Æ¡¢
.I extdocURL
¤Ï¥Õ¥¡¥¤¥ë¤Ç¤Ï¤Ê¤¯¡¢
.I extdocURL
¤Î URL ¤Ç¤¢¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.LP
¥É¥­¥å¥á¥ó¥È¤òǤ°Õ¤Î Web ¥µ¥¤¥È¾å¤Î¥É¥­¥å¥á¥ó¥È¤Ë¥ê¥ó¥¯¤¹¤ë¤Ë¤Ï
.I extdocURL
¤ÎÀäÂÐ¥ê¥ó¥¯¤ò¡¢ÁêÂÐ¥í¥±¡¼¥·¥ç¥ó¤À¤±¤ò»ØÄꤹ¤ë¤Ë¤Ï
ÁêÂÐ¥ê¥ó¥¯¤ò»ÈÍѤǤ­¤Þ¤¹¡£ÁêÂÐ¥ê¥ó¥¯¤ò»ÈÍѤ¹¤ë¾ì¹ç¡¢À¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê (\-d ¤Ç»ØÄê) ¤«¤é¤ÎÁêÂХѥ¹¤ò¡¢
¥ê¥ó¥¯Àè¥Ñ¥Ã¥±¡¼¥¸¤¬¤¢¤ë¥Ç¥£¥ì¥¯¥È¥ê¤ËÅϤ¹É¬Íפ¬¤¢¤ê¤Þ¤¹¡£
.LP
Ä̾ÀäÂÐ¥ê¥ó¥¯¤ò»ØÄꤹ¤ë¾ì¹ç¤Ï¡¢http: ¥ê¥ó¥¯¤ò»ÈÍѤ·¤Þ¤¹¡£
¤¿¤À¤·¡¢Web ¥µ¡¼¥Ð¤ò¤â¤¿¤Ê¤¤¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤Ë
¥ê¥ó¥¯¤¹¤ë¾ì¹ç¤Ï¡¢file: ¥ê¥ó¥¯¤ò»ÈÍѤǤ­¤Þ¤¹¡£
¤¿¤À¤·¡¢¤³¤ÎÊýË¡¤Ï¡¢À¸À®¤µ¤ì¤¿¥É¥­¥å¥á¥ó¥È¤Ë
¥¢¥¯¥»¥¹¤·¤è¤¦¤È¤¹¤ë
¤¹¤Ù¤Æ¤Î¥æ¡¼¥¶¤¬Æ±¤¸¥Õ¥¡¥¤¥ë¥·¥¹¥Æ¥à¤ò¶¦Í­¤·¤Æ¤¤¤ë
¾ì¹ç°Ê³°¤Ï»ÈÍѤ·¤Ê¤¤¤Ç¤¯¤À¤µ¤¤¡£
.LP
¤¹¤Ù¤Æ¤Î¾ì¹ç¡¢¤¹¤Ù¤Æ¤Î¥ª¥Ú¥ì¡¼¥Æ¥£¥ó¥°¥·¥¹¥Æ¥à¤Ç¡¢ÀäÂÐ URL ¤ÈÁêÂÐ URL¡¢¡Öhttp:¡×¥Ù¡¼¥¹¤È¡Öfile:¡×¥Ù¡¼¥¹¤Ë¤«¤«¤ï¤é¤º¡¢¥¹¥é¥Ã¥·¥å¤ò¶èÀÚ¤êʸ»ú¤È¤·¤Æ»ÈÍѤ·¤Þ¤¹
.fi
(http://www.ietf.org/rfc/rfc1738.txt
¤Î
.na
\f2URL Memo\fP ¤Ç»ØÄê)¡£
.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
.LP
javadoc ¼Â¹Ô»þ¤ËÊ£¿ô¤Î \-link ¥ª¥×¥·¥ç¥ó¤ò»ØÄꤷ¤Æ¡¢
Ê£¿ô¤Î¥É¥­¥å¥á¥ó¥È¤Ø¤Î¥ê¥ó¥¯¤òºîÀ®¤¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
.LP
\-linkoffline ¤Þ¤¿¤Ï \-link ¤ÎÁªÂò
.LP
\-link ¤ò»ÈÍѤ¹¤ë¾ì¹ç:
.TP 3
\(bu
³°Éô API ¥É¥­¥å¥á¥ó¥È¤Ø¤ÎÁêÂХѥ¹¤ò»ÈÍѤ·¤Æ¤¤¤ë
.TP 3
\(bu
³°Éô API ¥É¥­¥å¥á¥ó¥È¤Ø¤ÎÀäÂÐ URL ¤ò»ÈÍѤ·¤Æ¤¤¤ë (¥×¥í¥°¥é¥à¤¬¤½¤Î URL ¤ËÀܳ¤·¡¢Æɤ߼è¤ê¤ò¹Ô¤¦¤³¤È¤¬
¥·¥§¥ë¤Ë¤è¤Ã¤Æµö²Ä¤µ¤ì¤Æ¤¤¤ë¾ì¹ç)
.LP
\-linkoffline ¤ò»ÈÍѤ¹¤ë¾ì¹ç:
.TP 3
\(bu
³°Éô API ¥É¥­¥å¥á¥ó¥È¤Ø¤ÎÀäÂÐ URL ¤ò»ÈÍѤ·¤Æ¤¤¤ë
(¥×¥í¥°¥é¥à¤¬¤½¤Î URL ¤ËÀܳ¤·¡¢Æɤ߼è¤ê¤ò¹Ô¤¦¤³¤È¤¬
¥·¥§¥ë¤Ë¤è¤Ã¤Æµö²Ä¤µ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç)¡£¤³¤Î¤è¤¦¤Ê¾õ¶·¤Ï¡¢
¥ê¥ó¥¯Àè¤Î¥É¥­¥å¥á¥ó¥È¤¬¥Õ¥¡¥¤¥¢¥¦¥©¡¼¥ë¤Î
¸þ¤³¤¦Â¦¤Ë¤¢¤ë¾ì¹ç¤ËȯÀ¸¤·¤Þ¤¹¡£
.LP
³°Éô¥É¥­¥å¥á¥ó¥È¤Ø¤ÎÀäÂÐ¥ê¥ó¥¯¤Î»ÈÍÑÎã -
java.lang¡¢java.io¡¢¤ª¤è¤Ó¾¤Î Java 2 ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à¥Ñ¥Ã¥±¡¼¥¸
(\f2http://java.sun.com/j2se/1.5.0/docs/api\fP) ¤Ë
¥ê¥ó¥¯¤·¤¿¤¤¾ì¹ç¤¬¤¢¤ê¤Þ¤¹¡£
¼¡¤Î¥³¥Þ¥ó¥É¤Ï¡¢
Java 2 ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à¥Ñ¥Ã¥±¡¼¥¸¤Ø¤Î¥ê¥ó¥¯¤ò»ý¤Ä
com.mypackage ¥Ñ¥Ã¥±¡¼¥¸¤Î¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¤Þ¤¹¡£
À¸À®¤µ¤ì¤¿¥É¥­¥å¥á¥ó¥È¤Ë¤Ï¡¢¤¿¤È¤¨¤Ð¥¯¥é¥¹¥Ä¥ê¡¼Æâ¤Î
Object ¥¯¥é¥¹¤Ø¤Î¥ê¥ó¥¯¤¬´Þ¤Þ¤ì¤Æ¤¤¤Þ¤¹
(\-sourcepath ¤ä \-d ¤Ê¤É¤Î¾¤Î¥ª¥×¥·¥ç¥ó¤Ïɽ¼¨¤µ¤ì¤Þ¤»¤ó)¡£
.LP
.RS
.ft 3
.nf
% \fP\f3javadoc \-link http://java.sun.com/j2se/1.5.0/docs/api com.mypackage\fP
.fi
.ft 1
.RE
.LP
³°Éô ¥É¥­¥å¥á¥ó¥È¤Ø¤ÎÁêÂÐ¥ê¥ó¥¯¤Î»ÈÍÑÎã -
.B javadoc
¥Ä¡¼¥ë¤Î°Û¤Ê¤ë¼Â¹Ô¤ÇÀ¸À®¤µ¤ì¤¿¥É¥­¥å¥á¥ó¥È¤ò»ý¤Ä
2 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸¤¬¤¢¤ê¡¢¤½¤ì¤é¤¬ÊÌ¡¹¤Î
ÁêÂХѥ¹¤ò¤â¤Ã¤Æ¤¤¤ë¤È¤·¤Þ¤¹¡£
¤³¤ÎÎã¤Ç¤Ï¡¢2 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸¤ò
com.apipackage (API)¡¢com.spipackage
(SPI - Service Provide Interface) ¤È¤·¤Þ¤¹¡£ ¥É¥­¥å¥á¥ó¥È¤ÎÃÖ¤­¾ì½ê¤Ï docs/api/com/apipackage ¤ª¤è¤Ó
docs/spi/com/spipackage ¤Ç¤¹¡£
API ¥Ñ¥Ã¥±¡¼¥¸¥É¥­¥å¥á¥ó¥È¤Ï¤¹¤Ç¤ËÀ¸À®¤µ¤ì¡¢¥É¥­¥å¥á¥ó¥È¤¬¸½ºß¤Î
¥Ç¥£¥ì¥¯¥È¥êÆâ¤Ë¤¢¤ë¾ì¹ç¡¢¼¡¤Î¤è¤¦¤Ë¼Â¹Ô¤¹¤ë¤³¤È¤Ç¡¢
API ¥É¥­¥å¥á¥ó¥È¤Ë¥ê¥ó¥¯¤·¤¿ SPI ¥Ñ¥Ã¥±¡¼¥¸¤ò¥É¥­¥å¥á¥ó¥È²½¤Ç¤­¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-d ./spi \-link ../api com.spipackage
.fi
.ft 1
.RE
.LP
\-link °ú¿ô¤¬À¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê¤ÎÁêÂХѥ¹ (docs/spi) ¤Ç
¤¢¤ë¤³¤È¤ËÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
¾ÜºÙ -
\-link ¥ª¥×¥·¥ç¥ó¤ò»È¤¦¤È¡¢¥³¡¼¥É¤«¤é¤Ï»²¾È¤µ¤ì¤Æ¤¤¤Æ¤â¡¢
Javadoc ¤Î¸½ºß¤Î¼Â¹Ô¤Ç¤Ï¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤Ê¤¤¥¯¥é¥¹¤Ë¥ê¥ó¥¯
¤Ç¤­¤ë¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£ ¥ê¥ó¥¯¤«¤éÍ­¸ú¤Ê¥Ú¡¼¥¸¤Ë
°ÜÆ°¤Ç¤­¤ë¤è¤¦¤Ë¤¹¤ë¤Ë¤Ï¡¢¤½¤ì¤é¤Î HTML ¥Ú¡¼¥¸¤¬
¤¢¤ë¾ì½ê¤òÄ´¤Ù¡¢¤½¤Î¾ì½ê¤ò
.I extdocURL
¤Ë»ØÄꤹ¤ëɬÍפ¬¤¢¤ê¤Þ¤¹¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»È¤¦¤È¡¢¤¿¤È¤¨¤Ð¡¢¥µ¡¼¥É¥Ñ¡¼¥Æ¥£¤Î¥É¥­¥å¥á¥ó¥È¤«¤é¡¢
http://java.sun.com ¤Ë¤¢¤ë java.* ¤Î¥É¥­¥å¥á¥ó¥È¤Ë¥ê¥ó¥¯¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
º£²ó¤Î¼Â¹Ô¤Ç
.B javadoc
¤Ë¤è¤Ã¤ÆÀ¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥ÈÆâ¤Î
API ¤À¤±¤òÂоݤ˥ê¥ó¥¯¤òºîÀ®¤¹¤ë¾ì¹ç¤Ï¡¢
\-link ¥ª¥×¥·¥ç¥ó¤ò¾Êά¤·¤Þ¤¹¡£ \-link ¥ª¥×¥·¥ç¥ó¤¬
»ØÄꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢³°Éô»²¾È¤µ¤ì¤¿¥É¥­¥å¥á¥ó¥È¤Ø¤Î¥ê¥ó¥¯¤ò
ºîÀ®¤·¤Þ¤»¤ó¡£¤³¤ì¤Ï¡¢¤½¤Î¥É¥­¥å¥á¥ó¥È¤¬
¸ºß¤¹¤ë¤«¤É¤¦¤«¡¢¤¢¤ë¤¤¤Ï¸ºß¤·¤Æ¤¤¤Æ¤â¤É¤³¤Ë
¸ºß¤·¤Æ¤¤¤ë¤Î¤«¤òȽÊ̤Ǥ­¤Ê¤¤¤«¤é¤Ç¤¹¡£
.LP
¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢À¸À®¥É¥­¥å¥á¥ó¥ÈÆâ¤ÎÊ£¿ô¤Î¾ì½ê¤Ë
¥ê¥ó¥¯¤òºîÀ®¤Ç¤­¤Þ¤¹¡£
.LP
¤Þ¤¿¡¢¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»È¤¦¤È¡¢Ê£¿ô¤Î¥Ñ¥Ã¥±¡¼¥¸·²¤Î´Ö¤Ë¥¯¥í¥¹¥ê¥ó¥¯¤òºîÀ®¤¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£¤Ä¤Þ¤ê¡¢¤¢¤ë°ì¼°¤Î¥Ñ¥Ã¥±¡¼¥¸¤ËÂФ·¤Æ javadoc ¤ò¼Â¹Ô¤·¤¿¤¢¤È¡¢Ê̤ΰ켰¤Î¥Ñ¥Ã¥±¡¼¥¸¤ËÂФ·¤Æ javadoc ¤ò¼Â¹Ô¤·¡¢¤³¤ì¤é 2 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸·²¤Î´Ö¤Ë¥¯¥í¥¹¥ê¥ó¥¯¤òºîÀ®¤Ç¤­¤Þ¤¹¡£
.LP
\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
.LP
¤³¤Î·ë²Ì¡¢\f2\-link\fP ¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Æ¤â¡¢¤³¤ÎÀ©¸Â¤Î¤¿¤á¤Ë¸í¤Ã¤Æɽ¼¨¤µ¤ì¤Ê¤¤Â¿¤¯¤Î¥ê¥ó¥¯¤¬Â¿¿ôȯÀ¸¤¹¤ë²ÄǽÀ­¤¬¤¢¤ê¤Þ¤¹¡£¥Æ¥­¥¹¥È¤Ï¥Ï¥¤¥Ñ¡¼¥Æ¥­¥¹¥È¥ê¥ó¥¯¤¬ÉÕ¤±¤é¤ì¤º¤Ëɽ¼¨¤µ¤ì¤Þ¤¹¡£¤³¤ì¤é¤Î¥ê¥ó¥¯¤¬É½¼¨¤¹¤ë·Ù¹ð¤«¤é¡¢¤³¤Î¥ê¥ó¥¯¤òǧ¼±¤Ç¤­¤Þ¤¹¡£¥¯¥é¥¹¤òÀµ¤·¤¯»²¾È¤·¡¢¤½¤ì¤Ë¤è¤Ã¤Æ¥ê¥ó¥¯¤òÄɲ乤뤿¤á¤Î¤â¤Ã¤È¤â°ÂÁ´¤ÊÊýË¡¤Ï¾å¤ÇÀâÌÀ¤·¤¿¤È¤ª¤ê¡¢Åö³º¤Î¥¯¥é¥¹¤ò¥¤¥ó¥Ý¡¼¥È¤¹¤ë¤³¤È¤Ç¤¹¡£
.LP
.B ¥Ñ¥Ã¥±¡¼¥¸¥ê¥¹¥È:
.B \-link
¥ª¥×¥·¥ç¥ó¤Ç¤Ï¡¢javadoc ¥Ä¡¼¥ë¤Ë¤è¤Ã¤ÆÀ¸À®¤µ¤ì¤¿
.BR package-list
¤È¤¤¤¦Ì¾Á°¤Î¥Õ¥¡¥¤¥ë¤¬¡¢¤³¤Î¥ª¥×¥·¥ç¥ó¤Ç»ØÄꤹ¤ë URL ¤Ë¸ºß¤·¤Æ¤¤¤ë
ɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.BR package-list
¥Õ¥¡¥¤¥ë¤Ï¡¢¤½¤Î¾ì½ê¤Ç¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤Æ¤¤¤ë¥Ñ¥Ã¥±¡¼¥¸¤Î
̾Á°¤Î¥ê¥¹¥È¤ò´Þ¤àñ½ã¤Ê¥Æ¥­¥¹¥È¥Õ¥¡¥¤¥ë¤Ç¤¹¡£
Á°¤ÎÎã¤Ç¤Ï¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢»ØÄꤵ¤ì¤¿ URL ¤Ë¤¢¤ë
.BR package-list
¤È¤¤¤¦Ì¾Á°¤Î¥Õ¥¡¥¤¥ë¤òõ¤·¡¢¥Ñ¥Ã¥±¡¼¥¸Ì¾¤òÆɤ߹þ¤ó¤Ç¡¢
¤½¤Î URL ¤Ë¤¢¤ë¤½¤ì¤é¤Î¥Ñ¥Ã¥±¡¼¥¸¤Ø¤Î¥ê¥ó¥¯¤òºîÀ®¤·¤Þ¤·¤¿¡£
.LP
¤¿¤È¤¨¤Ð¡¢Java ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à v5.0 API ¤Î¥Ñ¥Ã¥±¡¼¥¸¥ê¥¹¥È¤Ï°Ê²¼¤Ë¤¢¤ê¡¢
.na
\f2http://java.sun.com/j2se/1.5.0/docs/api/package\-list\fP
.RE
.LP
¼¡¤Î¤è¤¦¤ÊÆâÍƤǻϤޤäƤ¤¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
java.applet
java.awt
java.awt.color
java.awt.datatransfer
java.awt.dnd
java.awt.event
java.awt.font
¤½¤Î¾ ...
.fi
.ft 1
.RE
.LP
.B \-link
¥ª¥×¥·¥ç¥ó¤ò»ØÄꤻ¤º¤Ë
.B javadoc
¥Ä¡¼¥ë¤ò¼Â¹Ô¤·¤¿¾ì¹ç¡¢¥É¥­¥å¥á¥ó¥È¤ÎÀ¸À®»þ¤Ë³°Éô»²¾È
¥¯¥é¥¹¤Ë°¤¹¤ë̾Á°¤ò
¸«¤Ä¤±¤ë¤È¡¢
.B javadoc
¤Ï¤½¤Î̾Á°¤ò¥ê¥ó¥¯¤ò»ý¤¿¤Ê¤¤·Á¤Ç½ÐÎϤ·¤Þ¤¹¡£°ìÊý¡¢
.B \-link
¥ª¥×¥·¥ç¥ó¤¬»ØÄꤵ¤ì¤Æ¤¤¤ë¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢»ØÄꤵ¤ì¤¿
.IR extdocURL
¤Î¾ì½ê¤Ë¤¢¤ë
.B package-list
¥Õ¥¡¥¤¥ë¤«¤é¡¢³ºÅö¤¹¤ë̾Á°¤Î¥Ñ¥Ã¥±¡¼¥¸¤òõ¤·¤Þ¤¹¡£¥Ñ¥Ã¥±¡¼¥¸Ì¾¤¬
¸«¤Ä¤«¤Ã¤¿¾ì¹ç¤Ï¡¢¤½¤Î
.IR extdocURL
¤ò̾Á°¤ÎÁ°¤ËÉÕ¤±¤Þ¤¹¡£
.LP
¤¹¤Ù¤Æ¤Î¥ê¥ó¥¯¤¬Àµ¤·¤¯µ¡Ç½¤¹¤ë¤¿¤á¤Ë¤Ï¡¢³°Éô»²¾È¤Î
¥É¥­¥å¥á¥ó¥È¤Î¤¹¤Ù¤Æ¤¬¡¢»ØÄꤵ¤ì¤¿ URL ¤Ë
¸ºß¤·¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢
.B package-list
¤¬Â¸ºß¤¹¤ë¤«¤É¤¦¤«¤òÄ´¤Ù¤ë¤À¤±¤Ç¡¢»ØÄꤵ¤ì¤¿ URL ¤Ë
ÌÜŪ¤Î¥Ú¡¼¥¸¤¬Â¸ºß¤¹¤ë¤«¤É¤¦¤«¤Ï¥Á¥§¥Ã¥¯¤·¤Þ¤»¤ó¡£
.LP
.B Ê£¿ô¤Î¥ê¥ó¥¯:
Ê£¿ô¤Î
.B \-link
¥ª¥×¥·¥ç¥ó¤òÄ󶡤·¤Æ¡¢³°Éô¤ÇÀ¸À®¤µ¤ì¤¿¥É¥­¥å¥á¥ó¥È¤ËǤ°Õ¿ô¤Î¥ê¥ó¥¯¤òÀßÄê¤Ç¤­¤Þ¤¹¡£Javadoc 1.2 ¤Ë¤Ï¡¢Ê£¿ô¤Î
.B -link
¥³¥Þ¥ó¥É¤òÄ󶡤Ǥ­¤Ê¤¤¤È¤¤¤¦¥Ð¥°¤¬¤¢¤ê¤Þ¤¹¡£¤³¤Î¥Ð¥°¤Ï¡¢
1.2.2 ¤Ç½¤Àµ¤µ¤ì¤Þ¤·¤¿¡£
.LP
¥ê¥ó¥¯¤¹¤ë³°Éô¥É¥­¥å¥á¥ó¥È¤´¤È¤ËÊ̤Υê¥ó¥¯¥ª¥×¥·¥ç¥ó¤ò»ØÄꤷ¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-link extdocURL1 \-link extdocURL2 ... \-link extdocURLn com.mypackage
.fi
.ft 1
.RE
.LP
.BR extdocURL1¡¢
.BR extdocURL2¡¢...
.BR extdocURLn
¤Ï¡¢¤½¤ì¤¾¤ì³°Éô¥É¥­¥å¥á¥ó¥È¤Î
¥ë¡¼¥È¤ò»Ø¤·¡¢³Æ¥ë¡¼¥È¤Ë¤Ï¡¢
.BR package-list
¤È¤¤¤¦Ì¾Á°¤Î¥Õ¥¡¥¤¥ë¤¬´Þ¤Þ¤ì¤Æ¤¤¤Þ¤¹¡£
.LP
¥¯¥í¥¹¥ê¥ó¥¯ - ¤Þ¤ÀÀ¸À®¤µ¤ì¤Æ¤¤¤Ê¤¤ 2 ¤Ä°Ê¾å¤Î¥É¥­¥å¥á¥ó¥È¤ò
¥¯¥í¥¹¥ê¥ó¥¯¤¹¤ë¾ì¹ç¤Ï¡¢¡Ö¥Ö¡¼¥È¥¹¥È¥é¥Ã¥Ô¥ó¥°¡×¤¬É¬Íפˤʤ뤳¤È¤Ë
Ãí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£¸À¤¤´¹¤¨¤ë¤È¡¢¤É¤Î¥É¥­¥å¥á¥ó¥È¤Î
.B package-list
¤â¸ºß¤·¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢ºÇ½é¤Î¥É¥­¥å¥á¥ó¥È¤ËÂФ·¤Æ
.B javadoc
¥Ä¡¼¥ë¤ò¼Â¹Ô¤·¤¿»þÅÀ¤Ç¤Ï¡¢2 ÈÖÌܤΥɥ­¥å¥á¥ó¥È¤Î
.B package-list
¤Ï¤Þ¤À¸ºß¤·¤Æ¤¤¤Þ¤»¤ó¡£¤·¤¿¤¬¤Ã¤Æ¡¢³°Éô¥ê¥ó¥¯¤òºîÀ®¤¹¤ë¤Ë¤Ï¡¢
2 ÈÖÌܤΥɥ­¥å¥á¥ó¥È¤ò
À¸À®¤·¤¿¤¢¤È¡¢ºÇ½é¤Î¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·Ä¾¤¹É¬Íפ¬¤¢¤ê¤Þ¤¹¡£
.LP
¤³¤Î¾ì¹ç¡¢ºÇ½é¤Ë¹Ô¤¦¥É¥­¥å¥á¥ó¥ÈÀ¸À®¤ÎÌÜŪ¤Ï¡¢
.B package-list
¤òºîÀ®¤¹¤ë¤³¤È¤Ç¤¹¡£¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò¤¹¤Ù¤ÆÇÄ°®¤·¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢
.B package-list
¤ò¼êÆ°¤ÇºîÀ®¤¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£¼¡¤Ë¡¢2 ÈÖÌܤΥɥ­¥å¥á¥ó¥È¤È
¤½¤Î³°Éô¥ê¥ó¥¯¤òÀ¸À®¤·¤Þ¤¹¡£
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢É¬Íפʳ°Éô¤Î
.B package-list
¥Õ¥¡¥¤¥ë¤¬Â¸ºß¤·¤Ê¤¤¾ì¹ç¤Ï¡¢·Ù¹ð¤òɽ¼¨¤·¤Þ¤¹¡£
.TP
.BI \-linkoffline " extdocURL packagelistLoc"
¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢
.BR \-link
¥ª¥×¥·¥ç¥ó¤òÊѤ¨¤¿¤â¤Î¤Ç¤¹¡£¤É¤Á¤é¤â¡¢javadoc ¤Ç
À¸À®¤µ¤ì¤¿³°Éô»²¾È¥¯¥é¥¹¤Î¥É¥­¥å¥á¥ó¥È¤Ø¤Î¥ê¥ó¥¯¤òºîÀ®¤·¤Þ¤¹¡£
.B Javadoc
¥Ä¡¼¥ë¤¬¡Ö¥ª¥Õ¥é¥¤¥ó¡×¤Ç¡¢Web ¾å¤Î¥É¥­¥å¥á¥ó¥È¤Ë
¥ê¥ó¥¯¤¹¤ë¾ì¹ç¤Ï¡¢Web Àܳ·Ðͳ¤Ç¤Ï¥É¥­¥å¥á¥ó¥È¤Ë
¥¢¥¯¥»¥¹¤Ç¤­¤Ê¤¤¤¿¤á¡¢
.B \-linkoffline
¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Þ¤¹¡£
.LP
¸·Ì©¤Ë¤Ï¡¢³°Éô¥É¥­¥å¥á¥ó¥È¤Î \f2package\-list\fP ¥Õ¥¡¥¤¥ë¤Ë¥¢¥¯¥»¥¹¤Ç¤­¤Ê¤¤¤È¤­¡¢¤Þ¤¿¤Ï¤³¤Î¥Õ¥¡¥¤¥ë¤¬ \f2extdocURL\fP ¤Ç»ØÄꤵ¤ì¤¿¾ì½ê¤È¤Ï°Û¤Ê¤ë¾ì½ê (Ä̾\f2packageListLoc\fP ¤Ç»ØÄê²Äǽ¤Ê¥í¡¼¥«¥ë¤Ê¾ì½ê) ¤Ë¸ºß¤¹¤ë¤È¤­¡¢\f2\-linkoffline\fP ¤ò»ÈÍѤ·¤Þ¤¹¡£¤·¤¿¤¬¤Ã¤Æ¡¢\f2extdocURL\fP ¤Ë WWW ¾å¤Ç¤·¤«¥¢¥¯¥»¥¹¤Ç¤­¤Ê¤¤¾ì¹ç¤Ï¡¢\f2\-linkoffline\fP ¤ò»ØÄꤹ¤ë¤³¤È¤Ë¤è¤ê¡¢¥É¥­¥å¥á¥ó¥È¤ÎÀ¸À®»þ¤Ë javadoc ¥Ä¡¼¥ë¤¬ Web ¤ËÀܳ¤Ç¤­¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¤È¤¤¤¦À©Ì󤬤ʤ¯¤Ê¤ê¤Þ¤¹¡£
.LP
¤µ¤é¤Ë¡¢¥É¥­¥å¥á¥ó¥È¤ò¹¹¿·¤¹¤ë¤¿¤á¤Î¡Ö¥Ï¥Ã¥­¥ó¥°¡×¤È¤·¤Æ¤Î»ÈÍѤâ²Äǽ¤Ç¤¹¡£¥Ñ¥Ã¥±¡¼¥¸¤Î¥»¥Ã¥ÈÁ´ÂΤËÂФ·¤Æ javadoc ¤ò¼Â¹Ô¤·¤¿¤¢¤È¡¢Êѹ¹¤·¤¿°ìÉô¤Î¥Ñ¥Ã¥±¡¼¥¸¤À¤±¤ËÂФ·¤Æ javadoc ¤ò¼Â¹Ô¤·¤Þ¤¹¡£¤³¤¦¤·¤Æ¡¢¹¹¿·¤µ¤ì¤¿¥Õ¥¡¥¤¥ë¤ò¡¢¥ª¥ê¥¸¥Ê¥ë¤Î¥Õ¥¡¥¤¥ë¥»¥Ã¥È¤ËÁÞÆþ¤Ç¤­¤ë¤è¤¦¤Ë¤·¤Þ¤¹¡£Îã¤ò¤¢¤È¤Ç¼¨¤·¤Þ¤¹¡£
.LP
.BR \-linkoffline
¥ª¥×¥·¥ç¥ó¤Ë¤Ï 2 ¤Ä¤Î°ú¿ô¤¬¤¢¤ê¤Þ¤¹¡£1 ¤Ä¤Ï
<a href> ¥ê¥ó¥¯¤ËËä¤á¹þ¤àʸ»úÎ󡢤⤦ 1 ¤Ä¤Ï
.BR package-list:
¤Î¸¡º÷¾ì½ê¤ò¼¨¤·¤Þ¤¹¡£
.LP
.RS
.TP 2
\(bu
.I extdocURL
¤Ï¡¢\f3javadoc\f1 ¤Ë¤è¤Ã¤ÆÀ¸À®¤µ¤ì¡¢¥ê¥ó¥¯Àè¤È¤·¤Æ»ØÄꤹ¤ë
³°Éô¥É¥­¥å¥á¥ó¥È¤¬¤¢¤ë¥Ç¥£¥ì¥¯¥È¥ê¤ÎÀäÂÐ
URL ¤Þ¤¿¤ÏÁêÂÐ URL ¤Ç¤¹¡£ ÁêÂÐ¥ê¥ó¥¯¤Î¾ì¹ç¡¢
À¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê (\-d ¤Ç»ØÄê) ¤«¤é¤ÎÁêÂХѥ¹¤ò¡¢
¥ê¥ó¥¯Àè¥Ñ¥Ã¥±¡¼¥¸¤Î¥ë¡¼¥È¤ËÅϤ¹É¬Íפ¬¤¢¤ê¤Þ¤¹¡£ ¾ÜºÙ¤Ï¡¢
.B \-link
¥ª¥×¥·¥ç¥ó¤Î
.I extdocURL
¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP 2
\(bu
.I packagelistLoc
¤Ë¤Ï¡¢³°Éô¥É¥­¥å¥á¥ó¥È¤Î
.B package-list
¥Õ¥¡¥¤¥ë¤¬Æþ¤Ã¤Æ¤¤¤ë¥Ç¥£¥ì¥¯¥È¥ê¤Î¥Ñ¥¹¤Þ¤¿¤Ï
URL ¤ò»ØÄꤷ¤Þ¤¹¡£ URL (http: ¤Þ¤¿¤Ï file:)
¤Þ¤¿¤Ï¥Õ¥¡¥¤¥ë¥Ñ¥¹¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
¤Þ¤¿¡¢ÀäÂХѥ¹¤ÈÁêÂХѥ¹¤Î¤É¤Á¤é¤Ç¤â¤«¤Þ¤¤¤Þ¤»¤ó¡£
ÁêÂХѥ¹¤Î¾ì¹ç¤Ï¡¢javadoc ¤¬¼Â¹Ô¤µ¤ì¤ë¸½ºß¤Î
¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¤ÎÁêÂХѥ¹¤È¤·¤Æ»ØÄꤷ¤Þ¤¹¡£
.BR package-list
¤È¤¤¤¦¥Õ¥¡¥¤¥ë̾¤Ï´Þ¤á¤Ê¤¤¤Ç¤¯¤À¤µ¤¤¡£
.LP
.B javadoc
¤Î 1 ²ó¤Î¼Â¹Ô¤Ç¡¢Ê£¿ô¤Î
.B \-linkoffline
¥ª¥×¥·¥ç¥ó¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
1.2.2 ¤è¤êÁ°¤Î¥Ð¡¼¥¸¥ç¥ó¤Ç¤Ï¡¢Ê£¿ô¤Î¥ª¥×¥·¥ç¥ó¤Ï»ØÄê¤Ç¤­¤Þ¤»¤ó¤Ç¤·¤¿¡£
.LP
³°Éô¥É¥­¥å¥á¥ó¥È¤Ø¤ÎÀäÂÐ¥ê¥ó¥¯¤ò»È¤Ã¤¿Îã -
.BR java.lang
¡¢
.BR java.io
¡¢¤ª¤è¤Ó¤½¤Î¾¤Î Java 2 ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à¥Ñ¥Ã¥±¡¼¥¸ (\f2http://java.sun.com/j2se/1.5.0/docs/api\fP)
¤Ë¥ê¥ó¥¯¤·¤¿¤¯¤Æ¤â¡¢Web ¤Ë¥¢¥¯¥»¥¹¤Ç¤­¤Ê¤¤
¾ì¹ç¤Ë¤Ä¤¤¤Æ¹Í¤¨¤Æ¤ß¤Þ¤¹¡£
.BR package-list
¥Õ¥¡¥¤¥ë¤ò¥Ö¥é¥¦¥¶¤Ç³«¤­ (\f2http://java.sun.com/j2se/1.5.0/docs/api/package\-list\fP)¡¢
¥í¡¼¥«¥ë¥Ç¥£¥ì¥¯¥È¥ê¤ËÊݸ¤·¤Þ¤¹¡£
¼¡¤Ë¡¢2 ÈÖÌܤΰú¿ô
.I packagelistLoc
¤Ç¤½¤Î¥í¡¼¥«¥ë¥³¥Ô¡¼¤ò»ØÄꤷ¤Þ¤¹¡£¤³¤Î¤È¤­
¥Ñ¥Ã¥±¡¼¥¸¥ê¥¹¥È¥Õ¥¡¥¤¥ë¤Ï¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê
¡Ö.¡×¤ËÊݸ¤µ¤ì¤Æ¤¤¤Þ¤¹¡£ ¼¡¤Î¥³¥Þ¥ó¥É¤Ï¡¢
Java 2 ¥×¥é¥Ã¥È¥Õ¥©¡¼¥à¥Ñ¥Ã¥±¡¼¥¸¤Ø¤Î¥ê¥ó¥¯¤ò´Þ¤à¡¢
com.mypackage ¥Ñ¥Ã¥±¡¼¥¸¤Î¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¤Þ¤¹¡£
À¸À®¤µ¤ì¤¿¥É¥­¥å¥á¥ó¥È¤Ë¤Ï¡¢¤¿¤È¤¨¤Ð¥¯¥é¥¹¥Ä¥ê¡¼Æâ¤Î
Object ¥¯¥é¥¹¤Ø¤Î¥ê¥ó¥¯¤¬´Þ¤Þ¤ì¤Æ¤¤¤Þ¤¹
(\-sourcepath ¤Ê¤É¤Î¾¤ÎɬÍפʥª¥×¥·¥ç¥ó¤Ïɽ¼¨¤µ¤ì¤Þ¤»¤ó)¡£
.LP
.RS
.ft 3
.nf
% \fP\f3javadoc \-linkoffline http://java.sun.com/j2se/1.5.0/docs/api . com.mypackage\fP
.fi
.ft 1
.RE
.LP
³°Éô¥É¥­¥å¥á¥ó¥È¤Ø¤ÎÁêÂÐ¥ê¥ó¥¯¤ò»È¤Ã¤¿Îã -
.B \-linkoffline
¤òÁêÂХѥ¹¤Ç»ØÄꤹ¤ë¤Î¤Ï¤¢¤Þ¤ê°ìÈÌŪ¤Ç¤Ï¤¢¤ê¤Þ¤»¤ó¡£Ä̾ï¤Ï¡¢
.B \-link
¤Ç½½Ê¬¤À¤«¤é¤Ç¤¹¡£
.B \-linkoffline
¤ò»ÈÍѤ·¤Æ¤¤¤ë¾ì¹ç¡¢
.BR package-list
¥Õ¥¡¥¤¥ë¤ÏÄ̾ï¥í¡¼¥«¥ë¤Ç¡¢ÁêÂÐ¥ê¥ó¥¯¤ò»ÈÍѤ·¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢
¥ê¥ó¥¯Àè¤Î¥Õ¥¡¥¤¥ë¤â¥í¡¼¥«¥ë¤Ç¤¢¤ë¤Î¤¬ÉáÄ̤Ǥ¹¡£
¤½¤Î¤¿¤á¡¢
.B \-linkoffline
¤Ë 2 ¤Ä¤Î°Û¤Ê¤ë°ú¿ô¤Î¥Ñ¥¹¤ò
Í¿¤¨¤ëɬÍפϤ¢¤ê¤Þ¤»¤ó¡£ 2 ¤Ä¤Î°ú¿ô¤¬Æ±¤¸¤Ç¤¢¤ë¾ì¹ç¡¢
.B \-link
¤ò»ÈÍѤǤ­¤Þ¤¹¡£
.B \-link
¤ÎÁêÂÐ¥ê¥ó¥¯¤Î»ÈÍÑÎã¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
package-list ¥Õ¥¡¥¤¥ë¤Î¼êÆ°ºîÀ® -
.BR package-list
¥Õ¥¡¥¤¥ë¤¬¤Þ¤À¸ºß¤·¤Ê¤¯¤Æ¤â¡¢¥É¥­¥å¥á¥ó¥È¤Î¥ê¥ó¥¯Àè¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤¬¤ï¤«¤Ã¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢¤³¤Î¥Õ¥¡¥¤¥ë¤Î¥³¥Ô¡¼¤ò¼«Ê¬¤ÇºîÀ®¤·¡¢
.I packagelistLoc
¤Ç¤½¤Î¥Ñ¥¹¤ò»ØÄꤹ¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
com.apipackage ¤¬ºÇ½é¤ËºîÀ®¤µ¤ì¤¿¤È¤­¤Ë
com.spipackage ¤Î¥Ñ¥Ã¥±¡¼¥¸¥ê¥¹¥È¤¬Â¸ºß¤·¤Ê¤«¤Ã¤¿¡¢
°ÊÁ°¤Î¾ì¹ç¤¬¤½¤ÎÎã¤Ç¤¹¡£
¤³¤ÎÊýË¡¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Ï¤ï¤«¤Ã¤Æ¤¤¤ë¤â¤Î¤Î¡¢
¤Þ¤À¸ø³«¤µ¤ì¤Æ¤¤¤Ê¤¤¡¢¿·¤·¤¤³°Éô¥É¥­¥å¥á¥ó¥È¤Ë¥ê¥ó¥¯¤¹¤ë
¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤¹¤ë¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£
¤Þ¤¿¡¢Javadoc 1.0 ¤Þ¤¿¤Ï 1.1 ¤Ç¤Ï package-list ¥Õ¥¡¥¤¥ë¤¬
À¸À®¤µ¤ì¤Ê¤¤¤¿¤á¡¢¤³¤ÎÊýË¡¤Ç¡¢¤³¤ì¤é¤Î¥Ð¡¼¥¸¥ç¥ó¤Ç
À¸À®¤µ¤ì¤¿¥Ñ¥Ã¥±¡¼¥¸¤Î package-list ¥Õ¥¡¥¤¥ë¤òÀ¸À®¤Ç¤­¤Þ¤¹¡£
2 ¤Ä¤Î²ñ¼Ò¤¬Ì¤¸ø³«¤Î package-list ¥Õ¥¡¥¤¥ë¤ò
¶¦Í­¤¹¤ë¤³¤È¤â¤Ç¤­¤ë¤¿¤á¡¢¥¯¥í¥¹¥ê¥ó¥¯¤òÀßÄꤷ¤¿
¥É¥­¥å¥á¥ó¥È¤òƱ»þ¤Ë¥ê¥ê¡¼¥¹¤¹¤ë¤³¤È¤â²Äǽ¤Ç¤¹¡£
.LP
Ê£¿ô¤Î¥É¥­¥å¥á¥ó¥È¤Ë¥ê¥ó¥¯ -
.B \-linkoffline
¤Ï¡¢»²¾ÈÀè¤ÎÀ¸À®¥É¥­¥å¥á¥ó¥È¤´¤È¤Ë 1 ¤Ä¤º¤Ä»ØÄꤷ¤Þ¤¹¡£
¼¡¤ÎÎã¤Ç¤Ï¡¢¤ï¤«¤ê¤ä¤¹¤¯¤¹¤ë¤¿¤á¤Ë
¥ª¥×¥·¥ç¥ó¤´¤È¤Ë¹Ô¤òʬ¤±¤Æ¤¤¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
.ta 18n
% javadoc \-linkoffline docURL1 packagelistURL1 \\
\-linkoffline docURL2 packagelistURL2 \\
.ft 1
...
.fi
.RE
.LP
.B ¥É¥­¥å¥á¥ó¥È¤Î¹¹¿·:
.B \-linkoffline
¥ª¥×¥·¥ç¥ó¤Î¤â¤¦ 1 ¤Ä¤ÎÍÑÅӤϡ¢¥×¥í¥¸¥§¥¯¥È¤Ç¿¿ô¤Î¥Ñ¥Ã¥±¡¼¥¸¤ò»È¤¤¡¢
¤¹¤Ç¤Ë¥Ä¥ê¡¼Á´ÂΤËÂФ·¤Æ
.B javadoc
¤ò¼Â¹Ô¤·¤Æ¤¢¤ë¾ì¹ç¤Ë¡¢¼¡¤Î¼Â¹Ô¤Ç¤Ï¡¢¤¹¤Ð¤ä¤¯ºÙ¤«¤¤
Êѹ¹¤ò¹Ô¤Ê¤Ã¤Æ¤«¤é¡¢¥½¡¼¥¹
¥Ä¥ê¡¼¤Î°ìÉô¤ËÂФ·¤Æ¤À¤±
.B javadoc
¤ò¼Â¹Ô¤·Ä¾¤·¤¿¤¤¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£¤³¤ì¤Ï¡¢
Êѹ¹¤¬¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ËÂФ·
¤Æ¤Ç¤¢¤ê¡¢¥·¥°¥Ë¥Á¥ã¤ËÂФ·¤Æ¤Ç¤Ï¤Ê¤¤¾ì¹ç¤Ë¤À¤±Àµ¾ï¤Ë
½èÍý¤µ¤ì¤ë¤Î¤Ç¡¢¥Ï¥Ã¥­¥ó¥°
¤Î¤è¤¦¤Ê¤â¤Î¤Ç¤¹¡£¥½¡¼¥¹¥³¡¼¥É¤ËÂФ·¤Æ¥·¥°¥Ë¥Á¥ã¤òÄɲá¢
ºï½ü¤Þ¤¿¤ÏÊѹ¹¤·¤¿¾ì¹ç¤Ï¡¢º÷°ú¡¢¥Ñ¥Ã¥±¡¼¥¸¥Ä¥ê¡¼¡¢
·Ñ¾µ¤µ¤ì¤ë¥á¥ó¥Ð¤Î¥ê¥¹¥È¡¢[»ÈÍÑ] ¥Ú¡¼¥¸¤Ê¤É¤Î¾ì½ê
¤Ç²õ¤ì¤¿¥ê¥ó¥¯¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£
.LP
¤Þ¤º¡¢¿·¤·¤¤¼Â¹Ô¤Î¤¿¤á¡¢¿·µ¬¤Î
À¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê (update) ¤òºîÀ®¤·¤Þ¤¹¡£¥ª¥ê¥¸¥Ê¥ë¤ÎÀ¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê¤ò html ¤È¤·¤Þ¤¹¡£¤â¤Ã¤È¤â´Êñ¤ÊÎã¤È¤·¤Æ¡¢html ¤Î¿Æ¤Ë°ÜÆ°¤·¤Þ¤¹¡£
.B \-linkoffline
¤Î 1 ÈÖÌܤΰú¿ô¤Ë¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¡Ö.¡×¤ò
ÀßÄꤷ¡¢2 ÈÖÌܤΰú¿ô¤Ë package-list
¤ò¸¡º÷¤¹¤ë¾ì½ê¤Ç¤¢¤ë html ¤Ø¤ÎÁêÂХѥ¹¤òÀßÄꤷ¤Þ¤¹¡£¹¹¿·¤·¤¿¤¤¥Ñ¥Ã¥±¡¼¥¸¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Î¤ß¤òÅϤ·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-d update \-linkoffline . html com.mypackage
.fi
.ft 1
.RE
.LP
.B javadoc
¤Î¼Â¹Ô¤¬½ªÎ»¤·¤¿¤È¤­¡¢
.B update/com/package
Æâ¤ËÀ¸À®¤µ¤ì¤¿¥¯¥é¥¹ (³µÍפäº÷°ú¤Ç¤Ï¤Ê¤¤) ¤Ç¡¢
html/com/package Æâ¤Ë¤¢¤ë¥ª¥ê¥¸¥Ê¥ë¤Î¥Õ¥¡¥¤¥ë¤ò¾å½ñ¤­¥³¥Ô¡¼¤·¤Þ¤¹¡£
.TP
\-linksource
³Æ¥½¡¼¥¹¥Õ¥¡¥¤¥ë (¹ÔÈÖ¹æÉÕ¤­) ¤Î HTML ¥Ð¡¼¥¸¥ç¥ó¤òºîÀ®¤·¡¢É¸½à HTML ¥É¥­¥å¥á¥ó¥È¤«¤é¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ø¤Î¥ê¥ó¥¯¤òÄɲä·¤Þ¤¹¡£¥ê¥ó¥¯¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ëÆâ¤ËÀë¸À¤µ¤ì¤Æ¤¤¤ë¥¯¥é¥¹¡¢¥¤¥ó¥¿¥Õ¥§¡¼¥¹¡¢¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¥Õ¥£¡¼¥ë¥É¤ËÂФ·¤ÆºîÀ®¤µ¤ì¤Þ¤¹¡£¥Ç¥Õ¥©¥ë¥È¥³¥ó¥¹¥È¥é¥¯¥¿¡¢À¸À®¤µ¤ì¤¿¥¯¥é¥¹¤ËÂФ·¤Æ¤ÏºîÀ®¤µ¤ì¤Þ¤»¤ó¡£
.LP
\f3¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢\fP\f4\-public\fP\f3¡¢\fP\f4\-package\fP\f3¡¢\fP\f4\-protected\fP\f3¡¢\fP\f4\-private\fP\f3 ¤Î³Æ¥ª¥×¥·¥ç¥ó¤È¤Ï´Ø·¸¤Ê¤¯¡¢Èó¸ø³«¤Î¥¯¥é¥¹¡¢¥Õ¥£¡¼¥ë¥É¡¢Èó¸ø³«¤Î¥á¥½¥Ã¥É¤ÎËÜÂΤò¤Ï¤¸¤á¤È¤¹¤ëÁȤ߹þ¤Þ¤ì¤¿¥½¡¼¥¹¥Õ¥¡¥¤¥ëÆâ¤Î\fP\f4¤¹¤Ù¤Æ¤Î\fP\f3Èó¸ø³«¼ÂÁõ¤Î¾ÜºÙ¤ò¸ø³«¤·¤Þ¤¹¡£\fP\f2\-private\fP ¥ª¥×¥·¥ç¥ó¤ò»ØÄꤷ¤Ê¤¤¤«¤®¤ê¡¢Èó¸ø³«¤Î¥¯¥é¥¹¤ä¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Î°ìÉô¤Ë¤Ï¡¢¥ê¥ó¥¯¤ò²ð¤·¤Æ¥¢¥¯¥»¥¹¤Ç¤­¤Ê¤¤¤³¤È¤¬¤¢¤ê¤Þ¤¹¡£
.LP
³Æ¥ê¥ó¥¯¤Ï¡¢¤½¤ÎÀë¸ÀÆâ¤Î¼±ÊÌ»Ò̾¤Î¾å¤ËºîÀ®¤µ¤ì¤Þ¤¹¡£¤¿¤È¤¨¤Ð¡¢\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
.LP
.TP
.BI \-group " groupheading packagepattern:packagepattern:..."
³µÍ×¥Ú¡¼¥¸¤ÎÊ£¿ô¤Î¥Ñ¥Ã¥±¡¼¥¸¤ò»ØÄê¤Î¥°¥ë¡¼¥×¤Ëʬ¤±¡¢
¥°¥ë¡¼¥×ñ°Ì¤Çɽ¤òºîÀ®
¤·¤Þ¤¹¡£³Æ¥°¥ë¡¼¥×¤Ï¡¢¤½¤ì¤¾¤ìÊ̤Î
.B \-group
¥ª¥×¥·¥ç¥ó¤Ç»ØÄꤷ¤Þ¤¹¡£¤³¤ì¤é¤Î¥°¥ë¡¼¥×¤Ï¡¢
¥³¥Þ¥ó¥É¹Ô¤Ç»ØÄꤷ¤¿½ç½ø¤Ç¥Ú¡¼¥¸¤Ë
ɽ¼¨¤µ¤ì¤Þ¤¹¡£¥Ñ¥Ã¥±¡¼¥¸¤Ï¡¢1 ¤Ä¤Î¥°¥ë¡¼¥×Æâ¤Ç¤Ï
¥¢¥ë¥Õ¥¡¥Ù¥Ã¥È½ç¤Ëʤ٤é¤ì¤Þ¤¹¡£³Æ
.B \-group
¥ª¥×¥·¥ç¥ó¤Ç¤Ï¡¢
.I packagepattern
¼°¤Î¥ê¥¹¥È¤Ë°ìÃפ¹¤ë
¥Ñ¥Ã¥±¡¼¥¸¤¬¡¢¸«½Ð¤·
.IR groupheading
¤ò»ý¤Ä 1 ¤Ä¤Îɽ¤Ë¤Þ¤È¤á¤Æɽ¼¨¤µ¤ì¤Þ¤¹¡£
.RS
.TP 2
\(bu
.I groupheading
¤Ë¤ÏǤ°Õ¤Î¥Æ¥­¥¹¥È¤ò»ØÄê¤Ç¤­¡¢¶õÇò¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
»ØÄꤷ¤¿¥Æ¥­¥¹¥È¤Ï¡¢¥°¥ë¡¼¥×¤Îɽ¸«½Ð¤·¤Ë¤Ê¤ê¤Þ¤¹¡£
.TP 2
\(bu
.I packagepattern
¤Ë¤Ï¡¢Ç¤°Õ¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¡¢¤Þ¤¿¤ÏǤ°Õ¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ÎÀèƬÉôʬ¤È¤½¤ì¤Ë³¤¯ 1 ¤Ä¤Î¥¢¥¹¥¿¥ê¥¹¥¯ (*)¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
¥¢¥¹¥¿¥ê¥¹¥¯¤Ï¡¢¡ÖǤ°Õ¤Îʸ»ú¤Ë°ìÃפ¹¤ë¡×¤È¤¤¤¦°ÕÌ£¤Î¥ï¥¤¥ë¥É¥«¡¼¥É¤Ç¤¹¡£¥ï¥¤¥ë¥É¥«¡¼¥É¤È¤·¤ÆµöÍƤµ¤ì¤ë¤Î¤Ï¡¢¥¢¥¹¥¿¥ê¥¹¥¯¤À¤±¤Ç¤¹¡£1 ¤Ä¤Î¥°¥ë¡¼¥×¤Ë¤Ï¡¢
¥³¥í¥ó (:) ¤Ç¶èÀڤä¿Ê£¿ô¤Î¥Ñ¥¿¡¼¥ó¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
Ãí: ¥Ñ¥¿¡¼¥ó¤ä¥Ñ¥¿¡¼¥ó¥ê¥¹¥ÈÆâ¤Ç¥¢¥¹¥¿¥ê¥¹¥¯¤ò
»È¤¦¾ì¹ç¤Ï¡¢"java.lang*:java.util"
¤Î¤è¤¦¤Ë¡¢¥Ñ¥¿¡¼¥ó¥ê¥¹¥È¤ò°úÍÑÉä¤Ç°Ï¤àɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.LP
.B \-group
¥ª¥×¥·¥ç¥ó¤¬ 1 ¤Ä¤â»ØÄꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¤Ï¡¢¤¹¤Ù¤Æ¤Î
¥Ñ¥Ã¥±¡¼¥¸¤¬¡¢[¥Ñ¥Ã¥±¡¼¥¸]
¤È¤¤¤¦¸«½Ð¤·¤ò»ý¤Ä 1 ¤Ä¤Î¥°¥ë¡¼¥×¤ËÆþ¤ì¤é¤ì¤Þ¤¹¡£
¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë¥Ñ¥Ã¥±¡¼¥¸¤Î
Ãæ¤Ë¡¢»ØÄꤷ¤¿¥°¥ë¡¼¥×¤Î¤É¤Î¥°¥ë¡¼¥×¤Ë¤âÆþ¤é¤Ê¤¤
¥Ñ¥Ã¥±¡¼¥¸¤¬¤¢¤ë¾ì¹ç¡¢¤³¤Î¤è¤¦¤Ê
¥Ñ¥Ã¥±¡¼¥¸¤Ï [¤½¤Î¾¤Î¥Ñ¥Ã¥±¡¼¥¸] ¤È¤¤¤¦¸«½Ð¤·¤ò
»ý¤ÄÆÈΩ¤·¤¿¥°¥ë¡¼¥×¤ËÆþ¤ì¤é¤ì¤Þ¤¹¡£
.LP
¤¿¤È¤¨¤Ð¡¢¼¡¤Î¤è¤¦¤Ë¥ª¥×¥·¥ç¥ó¤ò»ØÄꤹ¤ë¤È¡¢
¥É¥­¥å¥á¥ó¥È²½¤µ¤ì¤ë 4 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸¤Ï¡¢
¥³¥¢¥Ñ¥Ã¥±¡¼¥¸¡¢³ÈÄ¥µ¡Ç½¥Ñ¥Ã¥±¡¼¥¸¡¢
¤ª¤è¤Ó¤½¤Î¾¤Î¥Ñ¥Ã¥±¡¼¥¸¤Ëʬ¤«¤ì¤Þ¤¹¡£
\f3java.lang*\f1 ¤Ç¤Ï¡¢¸å³¤Î¥É¥Ã¥È¤¬¤Ê¤¤¤³¤È¤Ë
Ãí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£\f3java.lang.*\f1 ¤Î¤è¤¦¤Ë¥É¥Ã¥È¤ò
Æþ¤ì¤ë¤È¡¢
.B java.lang
¥Ñ¥Ã¥±¡¼¥¸¤Ï´Þ¤Þ¤ì¤Ê¤¤¤³¤È¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-group "Core Packages" "java.lang*:java.util"
\-group "Extension Packages" "javax.*"
java.lang java.lang.reflect java.util javax.servlet java.new
.fi
.ft 1
.RE
.LP
¤³¤Î·ë²Ì¡¢¼¡¤Î¤è¤¦¤Ê¥°¥ë¡¼¥×²½¤¬¹Ô¤ï¤ì¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
Core Packages
java.lang
java.lang.reflect
java.util
Extension Packages
javax.servlet
Other Packages
java.new
.fi
.ft 1
.RE
.RE
.TP
.B \-nodeprecated
¿ä¾©¤µ¤ì¤Ê¤¤ API ¤ò¥É¥­¥å¥á¥ó¥È¤ËÀ¸À®¤¹¤ë¤³¤È¤ò¶Ø»ß¤·¤Þ¤¹¡£
¤³¤ì¤Ï¡¢
.B \-nodeprecatedlist
¥ª¥×¥·¥ç¥ó¤ò»ØÄꤷ¤¿¾ì¹ç¤ÎÆ°ºî¤Ë²Ã¤¨¤Æ¡¢
¥É¥­¥å¥á¥ó¥È¤Î¤Û¤«¤ÎÉôʬ¤òÄ̤¸¤Æ¡¢
¿ä¾©¤µ¤ì¤Ê¤¤ API ¤òÀ¸À®¤·¤Ê¤¤¤³¤È¤ÈƱ¤¸¤Ç¤¹¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢¥³¡¼¥É¤òµ­½Ò¤·¤Æ¤¤¤Æ¡¢
¿ä¾©¤µ¤ì¤Ê¤¤¥³¡¼¥É¤ò̵»ë¤·¤¿¤¤¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£
.TP
.B \-nodeprecatedlist
¿ä¾©¤µ¤ì¤Ê¤¤ API ¤Î¥ê¥¹¥È¤ò´Þ¤à
¥Õ¥¡¥¤¥ë (\f3deprecated-list.html\f1) ¤ÎÀ¸À®¤ò¶Ø»ß
¤·¤Þ¤¹¡£¤Þ¤¿¡¢¤³¤Î¥Ú¡¼¥¸¤Ø¤Î¥ê¥ó¥¯¤ò
¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤ËÀ¸À®¤¹¤ë¤³¤È¤ò¶Ø»ß¤·¤Þ¤¹¡£
¤¿¤À¤·¡¢¥É¥­¥å¥á¥ó¥È¤Î¤Û¤«¤ÎÉôʬ¤Ç¤Ï¡¢
¿ä¾©¤µ¤ì¤Ê¤¤ API ¤ÎÀ¸À®¤ò³¹Ô¤·¤Þ¤¹¡£¤³¤Î
¥ª¥×¥·¥ç¥ó¤Ï¡¢¿ä¾©¤µ¤ì¤Ê¤¤ API ¤¬¥½¡¼¥¹¥³¡¼¥É¤Ë
´Þ¤Þ¤ì¤Æ¤ª¤é¤º¡¢¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤ò
¤¹¤Ã¤­¤ê¤È¸«¤»¤¿¤¤¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£
.TP
.B \-nosince
À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤«¤é¡¢
.BR @since
¥¿¥°¤Ë´ØÏ¢¤·¤¿¡ÖSince¡×¥»¥¯¥·¥ç¥ó¤òºï½ü¤·¤Þ¤¹¡£
.TP
.B \-notree
À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤«¤é¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹
³¬Áؤò¾Êά¤·¤Þ¤¹¡£¤³¤ì¤é¤Î¥Ú¡¼¥¸¤Ë¤Ï¡¢¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Î¡Ö¥Ä¥ê¡¼¡×¥Ü¥¿¥ó¤«¤é¥¢¥¯¥»¥¹¤Ç¤­¤Þ¤¹¡£
¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¡¢³¬Áؤ¬ºîÀ®¤µ¤ì¤Þ¤¹¡£
.TP
.B \-noindex
À¸À®¤µ¤ì¤ë¥É¥­¥å¥á¥ó¥È¤«¤éº÷°ú¤ò¾Êά¤·¤Þ¤¹¡£
¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¡¢
º÷°ú¤¬ºîÀ®¤µ¤ì¤Þ¤¹¡£
.TP
.B \-nohelp
³Æ½ÐÎÏ¥Ú¡¼¥¸¤ÎºÇ¾åÉô¤ÈºÇ²¼Éô¤Î
¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤«¤é [¥Ø¥ë¥×] ¥ê¥ó¥¯¤ò
¾Êά¤·¤Þ¤¹¡£
.TP
.B \-nonavbar
À¸À®¤µ¤ì¤ë¥Ú¡¼¥¸¤ÎºÇ¾åÉô¤ÈºÇ²¼Éô¤Ëɽ¼¨¤µ¤ì¤ë
¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¡¢¥Ø¥Ã¥À¡¢
¤ª¤è¤Ó¥Õ¥Ã¥¿¤ÎÀ¸À®¤ò¶Ø»ß¤·¤Þ¤¹¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢bottom ¥ª¥×¥·¥ç¥ó¤Ë¤Ï±Æ¶Á¤·¤Þ¤»¤ó¡£
.B \-nonavbar
¥ª¥×¥·¥ç¥ó¤Ï¡¢°õºþ¤¹¤ë¤¿¤á¤À¤±¤Ë
¥Õ¥¡¥¤¥ë¤ò PostScript ¤Þ¤¿¤Ï PDF ¤ËÊÑ´¹¤¹¤ë
¾ì¹ç¤Ê¤É¡¢ÆâÍƤÀ¤±¤¬½ÅÍפǥʥӥ²¡¼¥·¥ç¥ó¤Î
ɬÍ×À­¤¬¤Ê¤¤¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£
.TP
.BI \-helpfile " path/filename"
¾åÉô¤È²¼Éô¤Î¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Î [¥Ø¥ë¥×] ¥ê¥ó¥¯¤Î
¥ê¥ó¥¯Àè¤È¤Ê¤ëÂåÂإإë¥×¥Õ¥¡¥¤¥ë
.I path/filename
¤Î¥Ñ¥¹¤ò»ØÄꤷ¤Þ¤¹¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤¬»ØÄꤵ¤ì¤Æ¤¤¤Ê¤¤¾ì¹ç¡¢
.B javadoc
¤Ï¡¢javadoc ¤Ë¥Ï¡¼¥É¥³¡¼¥É¤µ¤ì¤Æ¤¤¤ë¥Ø¥ë¥×¥Õ¥¡¥¤¥ë
.B help-doc.html
¤ò¼«Æ°Åª¤ËºîÀ®¤·¤Þ¤¹¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»È¤¨¤Ð¡¢
¥Ç¥Õ¥©¥ë¥È¤ÎÀßÄê¤ò¥ª¡¼¥Ð¡¼¥é¥¤¥É¤Ç¤­
¤Þ¤¹¡£¥Õ¥¡¥¤¥ë̾¤Ë¤Ï¤É¤Î¤è¤¦¤Ê
̾Á°¤â»ØÄê¤Ç¤­¡¢\f3help-doc.html\f1 ¤Ë¤Ï¸ÂÄꤵ¤ì¤Þ
¤»¤ó¡£
.B javadoc
¤Ï¡¢¤½¤ì¤Ë½¾¤Ã¤Æ¡¢¥Ê¥Ó¥²¡¼¥·¥ç¥ó¥Ð¡¼¤Ë¤¢¤ë
¥ê¥ó¥¯¤ËÄ´À°¤ò²Ã¤¨¤Þ¤¹¡£
¼¡¤ËÎã¤ò¼¨¤·¤Þ¤¹¡£
.LP
.RS
.RS
.ft 3
.nf
% javadoc \-helpfile /home/doc/myhelp.html java.awt
.fi
.RE
.RE
.ft 1
.TP
.BI \-stylesheetfile " path/filename"
ÂåÂØ HTML ¥¹¥¿¥¤¥ë¥·¡¼¥È¥Õ¥¡¥¤¥ë¤Î¥Ñ¥¹¤ò»ØÄꤷ¤Þ¤¹¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤¬»ØÄꤵ¤ì¤Æ¤¤
¤Ê¤¤¾ì¹ç¡¢
.B javadoc
¥Ä¡¼¥ë¤Ï¡¢ÆâÉôŪ¤Ë¥Ï¡¼¥É¥³¡¼¥É¤µ¤ì¤Æ¤¤¤ë
¥¹¥¿¥¤¥ë¥·¡¼¥È¥Õ¥¡¥¤¥ë
.BR stylesheet.css
¤ò¼«Æ°Åª¤ËºîÀ®¤·¤Þ¤¹¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»È¤¨¤Ð¡¢
¥Ç¥Õ¥©¥ë¥È¤ÎÀßÄê¤ò¥ª¡¼¥Ð¡¼¥é¥¤¥É¤Ç¤­¤Þ¤¹¡£
filename ¤Ë¤Ï¤É¤ó¤Ê¥Õ¥¡¥¤¥ë̾¤Ç¤â»ØÄê¤Ç¤­¡¢
.BR stylesheet.css
¤Ë¤Ï¸ÂÄꤵ¤ì¤Þ¤»¤ó¡£
¼¡¤ËÎã¤ò¼¨¤·¤Þ¤¹¡£
.LP
.RS
.RS
.ft 3
.nf
% javadoc \-stylesheetfile /home/user/mystylesheet.css com.mypackage
.fi
.ft 1
.RE
.RE
.TP
.B \-serialwarn
.B @serial
¥¿¥°¤¬¤Ê¤¤¾ì¹ç¡¢¥³¥ó¥Ñ¥¤¥ë»þ¤Ë·Ù¹ð¤òÀ¸À®¤·¤Þ¤¹¡£¥Ç¥Õ¥©¥ë¥È¤Ç¤Ï¡¢
.B javadoc
1.2.2 (¤ª¤è¤Ó¤½¤ì°Ê¹ß) ¤Ï
.B @serial
¤Î·Ù¹ð¤òÀ¸À®¤·¤Þ¤»¤ó¡£
(¤³¤ì¤Ï¡¢°ÊÁ°¤Î¥Ð¡¼¥¸¥ç¥ó¤È¤ÏµÕ¤Ç¤¹¡£)
.B @serial
¤Î·Ù¹ð¤òÀ¸À®¤¹¤ë¤Ë¤Ï¡¢
¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Æ¤¯¤À¤µ¤¤¡£¤³¤Î¥ª¥×¥·¥ç¥ó¤Ï¡¢¥Ç¥Õ¥©¥ë¥È¤Î
ľÎó²½²Äǽ¤Ê¥Õ¥£¡¼¥ë¥É¤È writeExternal ¥á¥½¥Ã¥É¤òÀµ¤·¤¯
¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¤Î¤ËÌòΩ¤Á¤Þ¤¹¡£
.TP
.BI \-charset " name"
¤³¤Î¥É¥­¥å¥á¥ó¥ÈÍѤΠHTML ʸ»ú¥»¥Ã¥È¤ò»ØÄꤷ¤Þ¤¹¡£¤³¤Î̾Á°¤Ï¡¢
.na
\f2IANA Registry\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 ¥¿¥°¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.fi
http://www.w3.org/TR/REC\-html40/charset.html#h\-5.2.2
¤Î
.na
\f2HTML ¤Îɸ½à\fP (4197265 ¤ª¤è¤Ó 4137321) ¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
\-encoding ¤È \-docencoding ¤â»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.TP 3
\-docencoding\ name
À¸À®¤µ¤ì¤ë HTML ¥Õ¥¡¥¤¥ë¤Î¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤ò»ØÄꤷ¤Þ¤¹¡£¤³¤Î̾Á°¤Ï¡¢
.na
\f2IANA Registry\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 ¤â»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.TP 3
\-keywords
HTML ¥á¥¿¥­¡¼¥ï¡¼¥É¥¿¥°¤ò¡¢¥¯¥é¥¹¤´¤È¤ËÀ¸À®¤µ¤ì¤ë¥Õ¥¡¥¤¥ë¤ËÄɲä·¤Þ¤¹¡£¤³¤ì¤é¤Î¥¿¥°¤Ï¡¢¥á¥¿¥¿¥°¤ò¸¡º÷¤¹¤ë¥µ¡¼¥Á¥¨¥ó¥¸¥ó¤¬¥Ú¡¼¥¸¤ò¸«¤Ä¤±¤ë¾ì¹ç¤ËÌòΩ¤Á¤Þ¤¹¡£¥¤¥ó¥¿¡¼¥Í¥Ã¥ÈÁ´ÂΤò¸¡º÷¤¹¤ë¿¤¯¤Î¥µ¡¼¥Á¥¨¥ó¥¸¥ó¤Ï¡¢¥Ú¡¼¥¸¤¬¥á¥¿¥¿¥°¤ò¸íÍѤ·¤Æ¤¤¤ë¤¿¤á¡¢¥á¥¿¥¿¥°¤òÄ´¤Ù¤Þ¤»¤ó¡£°ìÊý¡¢¸¡º÷¤ò¼«¿È¤Î Web ¥µ¥¤¥È¤Ë¸ÂÄꤷ¤Æ¤¤¤ë´ë¶È¤Ç¤Ï¡¢¥µ¡¼¥Á¥¨¥ó¥¸¥ó¤¬¥á¥¿¥¿¥°¤òÄ´¤Ù¤ë¤³¤È¤Ë¤è¤Ã¤Æ¥á¥ê¥Ã¥È¤òÆÀ¤é¤ì¤Þ¤¹¡£
.LP
¥á¥¿¥¿¥°¤Ë¤Ï¡¢¥¯¥é¥¹¤Î´°Á´½¤¾þ̾¤È¡¢¥Õ¥£¡¼¥ë¥É¤ª¤è¤Ó¥á¥½¥Ã¥É¤Î½¤¾þ¤µ¤ì¤Æ¤¤¤Ê¤¤Ì¾Á°¤¬´Þ¤Þ¤ì¤Þ¤¹¡£¥³¥ó¥¹¥È¥é¥¯¥¿¤Ï¡¢¥¯¥é¥¹Ì¾¤ÈƱ¤¸¤Ç¤¢¤ë¤¿¤á´Þ¤Þ¤ì¤Þ¤»¤ó¡£¤¿¤È¤¨¤Ð¡¢¥¯¥é¥¹ 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
.LP
.TP 3
\-tag\ \ tagname:Xaoptcmf:"taghead"
Javadoc ¥Ä¡¼¥ë¤¬¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥ÈÆâ¤Î°ú¿ô¤ò 1 ¤Ä¼è¤ëñ½ã¤Ê¥«¥¹¥¿¥à¥Ö¥í¥Ã¥¯¥¿¥° \f2@\fP\f2tagname\fP ¤ò²ò¼á¤Ç¤­¤ë¤è¤¦¤Ë¤·¤Þ¤¹¡£¤³¤ì¤Ë¤è¤ê¡¢Javadoc ¥Ä¡¼¥ë¤Ï¥¿¥°Ì¾¤Î¡Ö¥¹¥Ú¥ë¥Á¥§¥Ã¥¯¡×¤ò¹Ô¤¦¤³¤È¤¬¤Ç¤­¤ë¤Î¤Ç¡¢¥½¡¼¥¹¥³¡¼¥ÉÆâ¤Î¤¹¤Ù¤Æ¤Î¥«¥¹¥¿¥à¥¿¥°¤Ë \f2\-tag\fP ¥ª¥×¥·¥ç¥ó¤òÁȤ߹þ¤à¤³¤È¤ò¤ª´«¤á¤·¤Þ¤¹¡£º£²ó¤Î¼Â¹Ô¤Ç½ÐÎϤµ¤ì¤Ê¤¤¥¿¥°¤Ï¡¢\f2X\fP ¤òÉÕ¤±¤Æ̵¸ú¤Ë¤·¤Þ¤¹¡£
.LP
¥³¥í¥ó (\f4:\fP) ¤Ï¾ï¤Ë¶èÀÚ¤êʸ»ú¤Ë¤Ê¤ê¤Þ¤¹¡£\f2tagname\fP ¤Ç¥³¥í¥ó¤ò»ÈÍѤ¹¤ë¤Ë¤Ï¡¢¡Ö¥¿¥°Ì¾¤Ç¤Î¥³¥í¥ó¤Î»ÈÍѡפò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
\f2\-tag\fP ¥ª¥×¥·¥ç¥ó¤Ï¡¢¥¿¥°¤Î¸«½Ð¤·¡Ö\f2taghead\fP¡×¤òÂÀ»ú¤Ç½ÐÎϤ·¤Þ¤¹¡£¤½¤Î¼¡¤Î¹Ô¤Ë¤Ï¡¢¤³¤Î¥ª¥×¥·¥ç¥ó¤Î°ú¿ô¤Ç»ØÄꤷ¤¿¥Æ¥­¥¹¥È¤¬Â³¤­¤Þ¤¹¡£°Ê²¼¤ÎÎã¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£¥Ö¥í¥Ã¥¯¥¿¥°¤ÈƱÍÍ¡¢¤³¤Î°ú¿ô¤Î¥Æ¥­¥¹¥È¤Ë¤Ï¥¤¥ó¥é¥¤¥ó¥¿¥°¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£¤³¤Î¥¤¥ó¥é¥¤¥ó¥¿¥°¤â²ò¼á¤µ¤ì¤Þ¤¹¡£½ÐÎϤϡ¢°ú¿ô¤ò 1 ¤Ä¼è¤ëɸ½à¤Î¥¿¥° (\f2@return\fP¡¢\f2@author\fP ¤Ê¤É) ¤Î½ÐÎϤȤ褯»÷¤Æ¤¤¤Þ¤¹¡£\f2taghead\fP ¤ò¾Êά¤¹¤ë¤È¡¢\f2tagname\fP ¤¬¸«½Ð¤·¤È¤·¤Æɽ¼¨¤µ¤ì¤Þ¤¹¡£
.LP
\f3¥¿¥°¤ÎÇÛÃÖ\fP \- °ú¿ô¤Î \f4Xaoptcmf\fP Éôʬ¤Ï¡¢¥½¡¼¥¹¥³¡¼¥ÉÆâ¤Î¥¿¥°¤òÇÛÃ֤Ǥ­¤ë°ÌÃ֤ȡ¢\f2X\fP ¤ò»È¤Ã¤Æ¤³¤Î¥¿¥°¤ò̵¸ú¤Ë¤Ç¤­¤ë¤«¤É¤¦¤«¤òÆÃÄꤷ¤Þ¤¹¡£¥¿¥°¤ÎÇÛÃÖ°ÌÃÖ¤òÀ©¸Â¤·¤Ê¤¤¾ì¹ç¤Ï \f4a\fP ¤ò»ØÄꤷ¤Þ¤¹¡£¤½¤ì°Ê³°¤Îʸ»ú¤ÎÁȤ߹ç¤ï¤»¤â²Äǽ¤Ç¤¹¡£
.br
\f4X\fP (¥¿¥°¤Î̵¸ú²½)
.br
\f4a\fP (¤¹¤Ù¤Æ¤Î°ÌÃÖ)
.br
\f4o\fP (³µÍ×)
.br
\f4p\fP (¥Ñ¥Ã¥±¡¼¥¸)
.br
\f4t\fP (·¿¤¹¤Ê¤ï¤Á¥¯¥é¥¹¤ª¤è¤Ó¥¤¥ó¥¿¥Õ¥§¡¼¥¹)
.br
\f4c\fP (¥³¥ó¥¹¥È¥é¥¯¥¿)
.br
\f4m\fP (¥á¥½¥Ã¥É)
.br
\f4f\fP (¥Õ¥£¡¼¥ë¥É)
.LP
¥·¥ó¥°¥ë¥¿¥°¤ÎÎã -
¥½¡¼¥¹¥³¡¼¥É¤ÎǤ°Õ¤Î¾ì½ê¤Ç»ÈÍѤǤ­¤ë
¥¿¥°¤Î¥¿¥°¥ª¥×¥·¥ç¥ó¤ÎÎã¤ò¼¨¤·¤Þ¤¹¡£
.LP
.RS
.TP 3
\-tag todo:a:"To Do:"
.RE
.LP
¥³¥ó¥¹¥È¥é¥¯¥¿¡¢¥á¥½¥Ã¥É¡¢¤ª¤è¤Ó¥Õ¥£¡¼¥ë¥É¤À¤±¤Ç @todo ¤ò
»ÈÍѤµ¤»¤ë¤Ë¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-tag todo:cmf:"To Do:"
.fi
.ft 1
.RE
.LP
¾åµ­¤Ç¤Ï¡¢ËöÈø¤Î¥³¥í¥ó (:) ¤¬¥Ñ¥é¥á¡¼¥¿¤Î
¶èÀڤ국¹æ¤Ç¤Ï¤Ê¤¯¡¢É½¼¨¤Î¤È¤ª¤ê¡¢
¸«½Ð¤·¥Æ¥­¥¹¥È¤Î°ìÉô¤Ç¤¢¤ë¤³¤È¤ËÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£
¼¡¤Î¤è¤¦¤Ë¡¢@todo ¥¿¥°¤ò´Þ¤à¥½¡¼¥¹¥³¡¼¥É¤Ë
¤É¤Á¤é¤«¤Î¥¿¥°¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
@todo The documentation for this method needs work.
.fi
.ft 1
.LP
¥¿¥°Ì¾¤Ë¥³¥í¥ó¤ò»ÈÍѤ¹¤ë \-
¥³¥í¥ó (:) ¤ò¥Ð¥Ã¥¯¥¹¥é¥Ã¥·¥å¤Ç¥¨¥¹¥±¡¼¥×¤¹¤ë¤È¡¢
¥³¥í¥ó¤ò¥¿¥°Ì¾¤Ë»ÈÍѤ¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
.RS 5
.nf
/**
* @ejb:bean
*/
.RE
.fi
.LP
¤Ç¤³¤Î¥¿¥°¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ¹¤ë¤È¡¢
.LP
.RS 5
.nf
\-tag ejb\\:bean:a:"EJB Bean:"
.RE
.LP
¤È¤Ê¤ê¤Þ¤¹¡£
.fi
.ft 1
.RE
.LP
¥¿¥°Ì¾¤Î¥¹¥Ú¥ë¥Á¥§¥Ã¥¯ (¥¿¥°¤Î̵¸ú²½) - ³«È¯¼Ô¤Ï¡¢¥½¡¼¥¹¥³¡¼¥É¤ÎÃæ¤Ç½ÐÎϤǤ­¤Ê¤¤¥«¥¹¥¿¥à¥¿¥°¤ò»ÈÍѤ¹¤ë¤³¤È¤¬¤¢¤ê¤Þ¤¹¡£¤½¤Î¾ì¹ç¡¢¥½¡¼¥¹¥¿¥°¤Ë¸ºß¤¹¤ë¤¹¤Ù¤Æ¤Î¥¿¥°¤ò¥ê¥¹¥È¤·¡¢½ÐÎϤ¹¤ë¥¿¥°¤òÍ­¸ú²½¤·¡¢½ÐÎϤ·¤Ê¤¤¥¿¥°¤ò̵¸ú²½¤¹¤ë¤³¤È¤¬½ÅÍפǤ¹¡£ X ¤ò»ÈÍѤ¹¤ë¤È¥¿¥°¤ò̵¸ú²½¤Ç¤­¡¢¤³¤ì¤¬¤Ê¤¤¾ì¹ç¤Ï¥¿¥°¤¬Í­¸ú¤È¤Ê¤ê¤Þ¤¹¡£ ¤³¤Îʸ»ú¤Î¸ºß¤Ë¤è¤Ã¤Æ¡¢
.B Javadoc
¥Ä¡¼¥ë¤Ï¡¢¸¡½Ð¤·¤¿¥¿¥°¤¬Ì¤ÃΤΥ¿¥°¤Ç¡¢¤ª¤½¤é¤¯ÄÖ¤ê´Ö°ã¤¤¤Ç¤¢¤ë¤ÈȽÃǤǤ­¤Þ¤¹¡£ ¤³¤Î¾ì¹ç¡¢·Ù¹ð¥á¥Ã¥»¡¼¥¸¤¬É½¼¨¤µ¤ì¤Þ¤¹¡£
.LP
¤¹¤Ç¤Ë¸ºß¤¹¤ë¡¢ÇÛÃÖ¤ò»ØÄꤹ¤ë°ú¿ô¤ÎÃÍ¤Ë X ¤òÄɲä·¤¿¾ì¹ç¡¢¥¿¥°¤òÍ­¸ú¤Ë¤·¤¿¤¤¤È¤­¤Ë X ¤òºï½ü¤Ç¤­¤Þ¤¹¡£ ¤¿¤È¤¨¤Ð¡¢@todo ¤¬½ÐÎϤ·¤¿¤¯¤Ê¤¤¥¿¥°¤Î¾ì¹ç¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-tag todo:Xcmf:"To Do:"
.fi
.ft 1
.RE
.LP
¤Þ¤¿¤Ï¡¢¼¡¤Î¤è¤¦¤Ë¤è¤ê´Êñ¤Ë¤¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-tag todo:X
.fi
.ft 1
.RE
.LP
\-tag todo:X ¤Î¹½Ê¸¤Ï¡¢@todo ¤¬¥¿¥°¥ì¥Ã¥È¤Ç
ÄêµÁ¤µ¤ì¤Æ¤¤¤ë¾ì¹ç¤âÍ­¸ú¤Ç¤¹¡£
.LP
¥¿¥°¤Î½ç½ø -
\-tag (¤ª¤è¤Ó \-taglet) ¥ª¥×¥·¥ç¥ó¤Î½ç½ø¤Ë½¾¤Ã¤Æ
¥¿¥°¤¬½ÐÎϤµ¤ì¤Þ¤¹¡£ ¥«¥¹¥¿¥à¥¿¥°¤Èɸ½à¥¿¥°¤ò
º®ºß¤µ¤»¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£ ɸ½à¥¿¥°¤Î¥¿¥°¥ª¥×¥·¥ç¥ó¤Ï¡¢
½ç½ø¤ò·èÄꤹ¤ë¤¿¤á¤À¤±¤Î¥×¥ì¡¼¥¹¥Û¥ë¥À¤Ç¤¹¡£
¤³¤ì¤é¤Ïɸ½à¥¿¥°Ì¾¤À¤±¤ò»ÈÍѤ·¤Þ¤¹
(ɸ½à¥¿¥°¤Î¾®¸«½Ð¤·¤ÏÊѹ¹¤Ç¤­¤Þ¤»¤ó)¡£
¤³¤ì¤ò¼¡¤ÎÎã¤Ë¼¨¤·¤Þ¤¹¡£
.LP
\-tag ¤¬¤Ê¤¤¾ì¹ç¡¢\-taglet ¤Î¾ì½ê¤Ë¤è¤Ã¤Æ¤½¤Î½ç½ø¤¬·è¤Þ¤ê¤Þ¤¹¡£
¤³¤Î 2 ¤Ä¤¬Î¾Êý¤¢¤ë¾ì¹ç¤Ï¡¢¥³¥Þ¥ó¥É¹Ô¤ÎºÇ¸å¤Ë»ÈÍѤµ¤ì¤¿Êý¤¬
½ç½ø¤ò·èÄꤷ¤Þ¤¹ (¤³¤ì¤Ï¡¢¥¿¥°¤È¥¿¥°¥ì¥Ã¥È¤¬¡¢
¥³¥Þ¥ó¥É¹Ô¤Ç»ÈÍѤµ¤ì¤¿½ç¤Ë½èÍý¤µ¤ì¤ë¤¿¤á¤Ç¤¹)¡£
¤¿¤È¤¨¤Ð¡¢\-taglet ¤È \-tag ¤¬Î¾Êý¤È¤â todo ¤È¤¤¤¦
̾Á°¤Ç¤¢¤ë¾ì¹ç¡¢¥³¥Þ¥ó¥É¹Ô¤ÎºÇ¸å¤Ç»ÈÍѤµ¤ì¤¿
Êý¤¬½ç½ø¤ò·èÄꤷ¤Þ¤¹¡£
.LP
¥¿¥°¤Î´°Á´¤Ê¥»¥Ã¥È¤ÎÎã -
¤³¤ÎÎã¤Ç¤Ï¡¢½ÐÎϤΠParameters ¤È Throws ¤Î´Ö¤Ë
To Do ¤òÁÞÆþ¤·¤Þ¤¹¡£ ¡ÖX¡×¤ò»ÈÍѤ·¤Æ¡¢@example ¤¬
¥½¡¼¥¹¥³¡¼¥ÉÆâ¤Îº£²ó¤Î¼Â¹Ô¤Ç½ÐÎϤµ¤ì¤Ê¤¤¥¿¥°¤Ç
¤¢¤ë¤³¤È¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£ @argfile ¤ò»ÈÍѤ¹¤ë¤È¡¢
¼¡¤Î¤è¤¦¤Ë¹Ô¤Î·Ñ³ʸ»ú¤Ê¤·¤Ç¡¢
°ú¿ô¥Õ¥¡¥¤¥ë¤Î°Û¤Ê¤ë¹Ô¤Ë¥¿¥°¤òÇÛÃ֤Ǥ­¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-tag param
\-tag return
\-tag todo:a:"To Do:"
\-tag throws
\-tag see
\-tag example:X
.fi
.ft 1
.RE
.LP
javadoc ¤¬¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¥³¥á¥ó¥È¤ò²òÀϤ¹¤ëºÝ¤Ë¡¢
¸¡½Ð¤µ¤ì¤¿¥¿¥°¤Î¤¦¤Á¡¢É¸½à¥¿¥°¤Ç¤â¤Ê¤¯¡¢
\-tag ¤ä \-taglet ¤ÇÅϤµ¤ì¤ë¥¿¥°¤Ç¤â¤Ê¤¤¤â¤Î¤Ï¡¢
ÉÔÌÀ¤Ê¥¿¥°¤È¤·¤Æǧ¼±¤·¡¢·Ù¹ð¤¬¥¹¥í¡¼¤µ¤ì¤Þ¤¹¡£
.LP
ɸ½à¥¿¥°¤Ï¡¢ºÇ½é¡¢¥Ç¥Õ¥©¥ë¥È¤Î½ç½ø¤Ç
¥ê¥¹¥ÈÆâÉôŪ¤Ë³ÊǼ¤µ¤ì¤Þ¤¹¡£
\-tag ¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ¹¤ë¤È¡¢¤³¤Î¥¿¥°¤¬¥ê¥¹¥È¤ËÄɲ䵤ì¤Þ¤¹¡£
ɸ½à¥¿¥°¤Ï¥Ç¥Õ¥©¥ë¥È¤Î°ÌÃÖ¤«¤é°ÜÆ°¤·¤Þ¤¹¡£
¤½¤Î¤¿¤á¡¢É¸½à¥¿¥°¤Ç \-tag ¥ª¥×¥·¥ç¥ó¤¬¾Êά¤µ¤ì¤ë¤È¡¢
¥Ç¥Õ¥©¥ë¥È¤Î°ÌÃÖ¤ËÇÛÃÖ¤µ¤ì¤¿¤Þ¤Þ¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
¶¥¹ç¤Î²óÈò -
¸ÇÍ­¤Î¥Í¡¼¥à¥¹¥Ú¡¼¥¹¤òºÙ¤«¤¯Ê¬¤±¤ë¤Ë¤Ï¡¢
¥Ñ¥Ã¥±¡¼¥¸¤Ë»ÈÍѤµ¤ì¤Æ¤¤¤ë com.mycompany.todo
¤È¤¤¤¦Ì¾Á°¤Î¤è¤¦¤Ë¡¢¥É¥Ã¥È (.) ¤ò¶èÀڤ국¹æ¤È¤¹¤ë̾Á°¤ò»È¤¤¤Þ¤¹¡£
Sun ¤Ïº£¸å¤â¥É¥Ã¥È¤ò´Þ¤Þ¤Ê¤¤É¸½à¥¿¥°¤òºîÀ®¤·¤Þ¤¹¡£
¥æ¡¼¥¶¤¬ºîÀ®¤·¤¿¥¿¥°¤Ï¡¢Sun ¤¬ÄêµÁ¤·¤¿Æ±¤¸
̾Á°¤Î¥¿¥°¤ÎÆ°ºî¤ò¥ª¡¼¥Ð¡¼¥é¥¤¥É¤·¤Þ¤¹¡£
¤Ä¤Þ¤ê¡¢¥æ¡¼¥¶¤¬ @todo ¤È¤¤¤¦Ì¾Á°¤Î¥¿¥°¤Þ¤¿¤Ï
¥¿¥°¥ì¥Ã¥È¤òºîÀ®¤·¤Æ¤¤¤¿¾ì¹ç¡¢¤½¤Î¤¢¤È¤Ç Sun ¤¬
Ʊ¤¸Ì¾Á°¤Îɸ½à¥¿¥°¤òºîÀ®¤·¤Æ¤â¡¢¥æ¡¼¥¶¤¬ÄêµÁ¤·¤¿
Æ°ºî¤Ï¤½¤Î¤Þ¤Þ°Ý»ý¤µ¤ì¤Þ¤¹¡£
.LP
\f3Ãí¼á vs. Javadoc ¥¿¥°\fP \- °ìÈ̤ˡ¢Äɲ乤ëɬÍפΤ¢¤ë¥Þ¡¼¥¯¥¢¥Ã¥×¤¬¡¢¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¤Ë±Æ¶Á¤òÍ¿¤¨¤¿¤ê¥É¥­¥å¥á¥ó¥Æ¡¼¥·¥ç¥ó¤òÀ¸À®¤·¤¿¤ê¤¹¤ë¤¿¤á¤Î¤â¤Î¤Ç¤¢¤ë¾ì¹ç¡¢¤½¤Î¥Þ¡¼¥¯¥¢¥Ã¥×¤Ï javadoc ¥¿¥°¤Ë¤¹¤Ù¤­¤Ç¤¹¡£¤½¤ì°Ê³°¤Î¾ì¹ç¤ÏÃí¼á¤Ë¤¹¤Ù¤­¤Ç¤¹¡£
.na
¡Ö\f2Comparing Annotations and Javadoc Tags\fP¡×
.fi
(http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#annotations) ¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
\-taglet ¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Æ¡¢¤è¤êÊ£»¨¤Ê
¥¹¥¿¥ó¥É¥¢¥í¥ó¥¿¥°¤ä¥«¥¹¥¿¥à¥¤¥ó¥é¥¤¥ó¥¿¥°¤ò
ºîÀ®¤¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.TP
\-taglet class
¥¿¥°¤Î¥É¥­¥å¥á¥ó¥È¤ÎÀ¸À®¤Ë»È¤¦¥¿¥°¥ì¥Ã¥È¤òµ¯Æ°¤¹¤ë¤¿¤á¤Î
¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤ò»ØÄꤷ¤Þ¤¹¡£
¥¯¥é¥¹¤Î´°Á´½¤¾þ̾¤ò»ØÄꤷ¤Æ¤¯¤À¤µ¤¤¡£
¤³¤Î¥¿¥°¥ì¥Ã¥È¤Ï¡¢¥«¥¹¥¿¥à¥¿¥°¤¬»ý¤Ã¤Æ¤¤¤ë¥Æ¥­¥¹¥È°ú¿ô¤Î
¿ô¤âÄêµÁ¤·¤Þ¤¹¡£ ¥¿¥°¥ì¥Ã¥È¤Ï¤³¤ì¤é¤Î°ú¿ô¤ò¼õ¤±¼è¤ê¡¢
½èÍý¤·¡¢½ÐÎϤòÀ¸À®¤·¤Þ¤¹¡£ ¥¿¥°¥ì¥Ã¥È¤ÎÎã¤Î¾ÜºÙ¤Ë¤Ä¤¤¤Æ¤Ï¡¢
¥¿¥°¥ì¥Ã¥È¤Î³µÍפò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
¥¿¥°¥ì¥Ã¥È¤Ï¥¹¥¿¥ó¥É¥¢¥í¥ó¥¿¥°¤Þ¤¿¤Ï¥¤¥ó¥é¥¤¥ó¥¿¥°¤Ë
»ÈÍѤ¹¤ë¤ÈÊØÍø¤Ç¤¹¡£ ¥¿¥°¥ì¥Ã¥È¤Ç¤ÏǤ°Õ¤Î
¿ô¤Î°ú¿ô¤ò»ý¤Ä¤³¤È¤¬¤Ç¤­¡¢¥«¥¹¥¿¥à¤ÎÆ°ºî¤ò¼ÂÁõ¤Ç¤­¤Þ¤¹¡£
¤¿¤È¤¨¤Ð¡¢¥Æ¥­¥¹¥È¤òÂÀ»ú¤Ë¤·¤¿¤ê¡¢²Õ¾ò½ñ¤­·Á¼°¤Ë¤·¤¿¤ê¡¢
¥Æ¥­¥¹¥È¤ò¥Õ¥¡¥¤¥ë¤Ë½ñ¤­½Ð¤·¤¿¤ê¡¢
¾¤Î¥×¥í¥»¥¹¤òµ¯Æ°¤·¤¿¤ê¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë¤Î¤Ç¤¹¡£
.LP
¥¿¥°¥ì¥Ã¥È¤Ç»ØÄê¤Ç¤­¤ë¤Î¤Ï¡¢¥¿¥°¤ÎÇÛÃÖ¾ì½ê¤ÈÇÛÃÖ·Á¼°¤Î¤ß¤Ç¤¹¡£¤½¤Î¾¤Î¤¹¤Ù¤Æ¤Î·èÄê¤Ï¡¢¥É¥Ã¥¯¥ì¥Ã¥È¤Ë¤è¤Ã¤Æ¹Ô¤ï¤ì¤Þ¤¹¡£¥¿¥°¥ì¥Ã¥È¤ò»ÈÍѤ·¤Æ¤â¡¢Êñ´Þ¥¯¥é¥¹¤Î¥ê¥¹¥È¤«¤é¥¯¥é¥¹Ì¾¤òºï½ü¤¹¤ë¤Ê¤É¤Î½èÍý¤Ï¼Â¹Ô¤Ç¤­¤Þ¤»¤ó¡£¤¿¤À¤·¡¢¥¿¥°¤Î¥Æ¥­¥¹¥È¤ò¥Õ¥¡¥¤¥ë¤Ë½ÐÎϤ·¤¿¤ê¡¢ÊÌ¤Î¥×¥í¥»¥¹¤ò¥È¥ê¥¬¤¹¤ë¤Ê¤É¤ÎÉûºîÍѤÏÆÀ¤é¤ì¤Þ¤¹¡£
.LP
¥¿¥°¥ì¥Ã¥È¤Ø¤Î¥Ñ¥¹¤ò»ØÄꤹ¤ë¤Ë¤Ï¡¢
.B \-tagletpath
¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Þ¤¹¡£
À¸À®¤µ¤ì¤¿¥Ú¡¼¥¸¤Î Parameters ¤È Throws ¤Î´Ö¤Ë
To Do ¥¿¥°¥ì¥Ã¥È¤òÁÞÆþ¤¹¤ëÎã¤ò¼¨¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-taglet com.sun.tools.doclets.ToDoTaglet
\-tagletpath /home/taglets
\-tag return
\-tag param
\-tag todo
\-tag throws
\-tag see
.fi
.ft 1
.RE
.LP
.B \-taglet
¥ª¥×¥·¥ç¥ó¤ò
.B \-tag
¥ª¥×¥·¥ç¥ó¤ÎÂå¤ï¤ê¤Ë»ÈÍѤ¹¤ë¤³¤È¤â¤Ç¤­¤Þ¤¹¤¬¡¢
¤½¤Î·ë²Ì¡¢Æɤߤˤ¯¤¯¤Ê¤ê¤Þ¤¹¡£
.TP
\-tagletpath tagletpathlist
taglet ¥¯¥é¥¹¥Õ¥¡¥¤¥ë (.class) ¤òõ¤¹¤¿¤á¤Î¸¡º÷¥Ñ¥¹¤ò»ØÄꤷ¤Þ¤¹¡£
.I tagletpathlist
¤Ë¤Ï¡¢¥³¥í¥ó (:) ¤Ç
¶èÀڤäÆÊ£¿ô¤Î¥Ñ¥¹¤ò´Þ¤á¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.B Javadoc
¥Ä¡¼¥ë¤Ï¡¢»ØÄꤵ¤ì¤¿¥Ñ¥¹°Ê²¼¤Î¤¹¤Ù¤Æ¤Î
¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤ò¸¡º÷¤·¤Þ¤¹¡£
.TP
\-docfilessubdirs
doc-files ¥Ç¥£¥ì¥¯¥È¥ê¤ò¡¢²¼¤Î³¬Áؤò´Þ¤á¤Æ¥³¥Ô¡¼
¤Ç¤­¤ë¤è¤¦¤Ë¤·¤Þ¤¹¡£ ¤Ä¤Þ¤ê¡¢¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤È¤¹¤Ù¤Æ¤Î
¥³¥ó¥Æ¥ó¥Ä¤¬¡¢À¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê¤ËºÆµ¢Åª¤Ë¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£
¤¿¤È¤¨¤Ð¡¢
.BR doc-files/example/images
¥Ç¥£¥ì¥¯¥È¥ê¤È¤½¤ÎÃæ¤Î¥Õ¥¡¥¤¥ë¤¬¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£
¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤ò½ü³°¤¹¤ë¤¿¤á¤Î¥ª¥×¥·¥ç¥ó¤â¤¢¤ê¤Þ¤¹¡£
.TP
\-excludedocfilessubdirs name1:name2:...
doc-files ¤Î¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤Ç¡¢»ØÄꤵ¤ì¤¿
̾Á°¤Î¤â¤Î¤ò½ü³°¤·¤Þ¤¹¡£ ¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ¹¤ë¤È¡¢
SCCS ¤ª¤è¤Ó¤½¤Î¾¤Î¥½¡¼¥¹¥³¡¼¥É´ÉÍý¤Î
¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤ò¥³¥Ô¡¼¤·¤Ê¤¤¤è¤¦¤Ë¤Ç¤­¤Þ¤¹¡£
.TP
\-noqualifier all | packagename1:packagename2:...
½¤¾þ¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò¡¢½ÐÎϤΥ¯¥é¥¹Ì¾¤ÎÁ°¤«¤éºï½ü¤·¤Þ¤¹¡£
\-noqualifier ¤Î°ú¿ô¤Ï
all (¤¹¤Ù¤Æ¤Î¥Ñ¥Ã¥±¡¼¥¸½¤¾þ»Ò¤òºï½ü)¡¢
¤Þ¤¿¤Ï¥³¥í¥ó¤Ç¶èÀÚ¤é¤ì¤¿¥Ñ¥Ã¥±¡¼¥¸¥ê¥¹¥È¤Î
¤¤¤º¤ì¤«¤Ç¡¢½¤¾þ»Ò¤È¤·¤Æºï½ü¤µ¤ì¤Þ¤¹¡£
¥ï¥¤¥ë¥É¥«¡¼¥É¤â»ÈÍѤǤ­¤Þ¤¹¡£
¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Ï¥¯¥é¥¹Ì¾¤Þ¤¿¤Ï¥¤¥ó¥¿¥Õ¥§¡¼¥¹Ì¾¤¬
ɽ¼¨¤µ¤ì¤¿¤È¤³¤í¤«¤éºï½ü¤µ¤ì¤Þ¤¹¡£
.LP
¼¡¤ÎÎã¤Ç¤Ï¡¢¤¹¤Ù¤Æ¤Î¥Ñ¥Ã¥±¡¼¥¸½¤¾þ»Ò¤ò¾Êά¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-noqualifier all
.fi
.ft 1
.RE
.LP
¼¡¤ÎÎã¤Ç¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸½¤¾þ»Ò java.lang
¤ª¤è¤Ó java.io ¤ò¾Êά¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-noqualifier java.lang:java.io
.fi
.ft 1
.RE
.LP
¼¡¤ÎÎã¤Ç¤Ï¡¢java ¤ª¤è¤Ó com.sun ¤«¤é
»Ï¤Þ¤ë (javax ¤ò½ü¤¯)
¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤Î¥Ñ¥Ã¥±¡¼¥¸½¤¾þ»Ò¤òºï½ü¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-noqualifier java.*:com.sun.*
.fi
.ft 1
.RE
.LP
¥Ñ¥Ã¥±¡¼¥¸½¤¾þ»Ò¤¬¾åµ­¤ÎÆ°ºî¤Ë½¾¤Ã¤Æɽ¼¨¤µ¤ì¤ë¾ì¹ç¡¢Ì¾Á°¤ÏŬÀÚ¤Ëû¤¯¤µ¤ì¤Þ¤¹¡£¾ÜºÙ¤Ï¡Ö̾Á°¤Îɽ¼¨ÊýË¡¡×¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£¤³¤Îµ¬Â§¤Ï¡¢
\-noqualifier ¤¬
»ÈÍѤµ¤ì¤Æ¤¤¤ë¤«¤É¤¦¤«¤Ë¤«¤«¤ï¤é¤ºÂ¸ºß¤·¤Þ¤¹¡£
.TP
.BI \-notimestamp
¥¿¥¤¥à¥¹¥¿¥ó¥×¤¬ÍÞÀ©¤µ¤ì¤Þ¤¹¡£
³Æ¥Ú¡¼¥¸ÀèƬ¶á¤¯¤Ë¤¢¤ë¡¢À¸À®¤µ¤ì¤¿ HTML Æâ¤Î
HTML ¥³¥á¥ó¥È¤Ç¥¿¥¤¥à¥¹¥¿¥ó¥×¤¬±£¤µ¤ì¤Þ¤¹¡£
.B Javadoc
¤ò 2 ¤Ä¤Î¥½¡¼¥¹¥Ù¡¼¥¹¤Ç¼Â¹Ô¤·¡¢¤½¤ì¤é¤ËÂФ·¤Æ
diff ¤ò¼Â¹Ô¤¹¤ë¤È¤­¤Ë¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ¹¤ë¤È¡¢
¥¿¥¤¥à¥¹¥¿¥ó¥×¤Ë¤è¤Ã¤Æ diff ¤¬È¯À¸¤·¤Ê¤¯¤Ê¤ë¤Î¤Ç
ÊØÍø¤Ç¤¹ (¤³¤Î¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Ê¤¤¤È¡¢
³Æ¥Ú¡¼¥¸¤Ç diff ¤Ë¤Ê¤ê¤Þ¤¹)¡£
¥¿¥¤¥à¥¹¥¿¥ó¥×¤Ë¤Ï
.B Javadoc
¤Î¥Ð¡¼¥¸¥ç¥óÈֹ椬´Þ¤Þ¤ì¤Æ¤ª¤ê¡¢
¼¡¤Î¤è¤¦¤Ë¤Ê¤ê¤Þ¤¹¡£
.LP
.RS 5
<!-- Generated by javadoc (build 1.5.0-internal)
on Tue Jun 22 09:57:24 PDT 2004 -->
.RE
.TP
\-nocomment
µ­½Ò¤ª¤è¤Ó¤¹¤Ù¤Æ¤Î¥¿¥°¤ò´Þ¤à¥³¥á¥ó¥È
ËÜʸÁ´ÂΤòÍÞÀ©¤·¡¢Àë¸À¤À¤±¤òÀ¸À®¤·¤Þ¤¹¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤Ë¤è¤ê¡¢¸µ¤Ï°Û¤Ê¤ëÌÜŪ¤Î¤¿¤á¤À¤Ã¤¿
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤òºÆÍøÍѤ·¡¢
¿·¤·¤¤¥×¥í¥¸¥§¥¯¥È¤Î¤¿¤á¤Î¥¹¥±¥ë¥È¥ó¤ò
ºîÀ®¤Ç¤­¤ë¤è¤¦¤Ë¤Ê¤ê¤Þ¤·¤¿¡£
.SS ¥³¥Þ¥ó¥É¹Ô°ú¿ô¥Õ¥¡¥¤¥ë
.BR javadoc
¤Î¥³¥Þ¥ó¥É¹Ô¤òû¤¯¤·¤¿¤ê´Ê·é¤Ë¤·¤¿¤ê¤¹¤ë¤¿¤á¤Ë¡¢
.BR javadoc
¥³¥Þ¥ó¥É¤ËÂФ¹¤ë°ú¿ô (\-J ¥ª¥×¥·¥ç¥ó¤ò½ü¤¯) ¤¬
Æþ¤Ã¤¿ 1 ¤Ä°Ê¾å¤Î¥Õ¥¡¥¤¥ë¤ò»ØÄꤹ¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
¤³¤Î¤³¤È¤òÍøÍѤ¹¤ì¤Ð¡¢¤É¤Î¥ª¥Ú¥ì¡¼¥Æ¥£¥ó¥°¥·¥¹¥Æ¥à
¾å¤Ç¤â¡¢Ç¤°Õ¤ÎŤµ¤Î
.BR javadoc
¥³¥Þ¥ó¥É¤òºîÀ®¤Ç¤­¤Þ¤¹¡£
.LP
°ú¿ô¥Õ¥¡¥¤¥ë¤Ë¤Ï¡¢javac ¥ª¥×¥·¥ç¥ó¤È¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾¤ò
¼«Í³¤ËÁȤ߹ç¤ï¤»¤Æµ­½Ò¤Ç¤­¤Þ¤¹¡£
¤Þ¤¿¡¢Javadoc ¥ª¥×¥·¥ç¥ó¤ËÂФ¹¤ë°ú¿ô¤À¤±¤òµ­½Ò¤·¤Æ¤â¤«¤Þ¤¤¤Þ¤»¤ó¡£
¥Õ¥¡¥¤¥ëÆâ¤Î³Æ°ú¿ô¤Ï¡¢¶õÇòʸ»ú¤Þ¤¿¤Ï²þ¹Ô¤Ç¶èÀÚ¤ê¤Þ¤¹¡£
¥Õ¥¡¥¤¥ë̾¤Ë¶õÇò¤¬´Þ¤Þ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢¤½¤Î¥Õ¥¡¥¤¥ë̾Á´ÂΤòÆó½Å°úÍÑÉä¤Ç°Ï¤àɬÍפ¬¤¢¤ê¤Þ¤¹¡£
.LP
.LP
°ú¿ô¥Õ¥¡¥¤¥ëÆâ¤Î¥Õ¥¡¥¤¥ë̾¤Ï¡¢
¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¸«¤¿ÁêÂХѥ¹¤Ë¤Ê¤ê¤Þ¤¹¡£
°ú¿ô¥Õ¥¡¥¤¥ë¤Î°ÌÃÖ¤«¤é¸«¤¿ÁêÂХѥ¹¤Ç¤Ï¤¢¤ê¤Þ¤»¤ó¡£
°ú¿ô¥Õ¥¡¥¤¥ëÆâ¤Î¥Õ¥¡¥¤¥ë̾¥ê¥¹¥È¤Ç¤Ï¡¢
¥ï¥¤¥ë¥É¥«¡¼¥É (*) ¤Ï»ÈÍѤǤ­¤Þ¤»¤ó¡£
¤¿¤È¤¨¤Ð¡¢*.java ¤È¤Ï»ØÄê¤Ç¤­¤Þ¤»¤ó¡£
°ú¿ô¥Õ¥¡¥¤¥ëÆâ¤Î°ú¿ô¤Ç @ ʸ»ú¤ò»ÈÍѤ·¤Æ¡¢
Ê£¿ô¤Î¥Õ¥¡¥¤¥ë¤òºÆµ¢Åª¤Ë²ò¼á¤¹¤ë¤³¤È¤Ï¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤Þ¤»¤ó¡£
¤Þ¤¿¡¢\-J ¥ª¥×¥·¥ç¥ó¤â¥µ¥Ý¡¼¥È¤µ¤ì¤Æ¤¤¤Þ¤»¤ó¡£
¤³¤Î¥ª¥×¥·¥ç¥ó¤Ïµ¯Æ°¥Ä¡¼¥ë¤ËÅϤµ¤ì¤Þ¤¹¤¬¡¢
µ¯Æ°¥Ä¡¼¥ë¤Ç¤Ï°ú¿ô¥Õ¥¡¥¤¥ë¤ò¥µ¥Ý¡¼¥È¤·¤Æ¤¤¤Ê¤¤¤«¤é¤Ç¤¹¡£
.LP
.BR javadoc
¤ò¼Â¹Ô¤¹¤ë¤È¤­¤Ë¡¢³Æ°ú¿ô¥Õ¥¡¥¤¥ë¤Î¥Ñ¥¹¤È¥Õ¥¡¥¤¥ë̾¤Î
ÀèƬ¤Ë @ ʸ»ú¤òÉÕ¤±¤ÆÅϤ·¤Þ¤¹¡£
.BR javadoc
¤Ï¡¢@ ʸ»ú¤Ç»Ï¤Þ¤ë°ú¿ô¤ò¸«¤Ä¤±¤ë¤È¡¢
¤½¤Î¥Õ¥¡¥¤¥ë¤ÎÆâÍƤòŸ³«¤·¤Æ°ú¿ô¥ê¥¹¥È¤ËÁÞÆþ¤·¤Þ¤¹¡£
.LP
°ú¿ô¥Õ¥¡¥¤¥ë¤ò 1 ¤Ä»ØÄꤹ¤ëÎã
.LP
argfile ¤È¤¤¤¦Ì¾Á°¤Î°ú¿ô¥Õ¥¡¥¤¥ë¤Ë¤¹¤Ù¤Æ¤Î
Javadoc °ú¿ô¤ò³ÊǼ¤·¡¢¼¡¤Î¤è¤¦¤Ë»ÈÍѤ¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc @argfile
.fi
.ft 1
.RE
.LP
¤³¤Î°ú¿ô¥Õ¥¡¥¤¥ë¤Ë¤Ï¡¢¼¡¤ÎÎã¤Ç¼¨¤µ¤ì¤Æ¤¤¤ë
2 ¤Ä¤Î¥Õ¥¡¥¤¥ë¤ÎÆâÍƤòξÊý¤È¤âÆþ¤ì¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
.LP
°ú¿ô¥Õ¥¡¥¤¥ë¤ò 2 ¤Ä»ØÄꤹ¤ëÎã
.LP
Javadoc ¥ª¥×¥·¥ç¥óÍÑ¤Ë 1 ¤Ä¡¢¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Þ¤¿¤Ï¥½¡¼¥¹¥Õ¥¡¥¤¥ë̾ÍѤË
1 ¤Ä¤È¤¤¤¦¤è¤¦¤Ë¡¢2 ¤Ä¤Î°ú¿ô¥Õ¥¡¥¤¥ë¤òºîÀ®¤·¡¢
¼¡¤Î¤è¤¦¤Ë¤·¤Æ»ÈÍѤ¹¤ë¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
¤Ê¤ª¡¢¤³¤Î¤¢¤È¤Î¥ê¥¹¥È¤Ç¤Ï¡¢¹Ô¤Î·Ñ³ʸ»ú¤ò»ÈÍѤ·¤Æ¤¤¤Þ¤»¤ó¡£
.LP
°Ê²¼¤ÎÆâÍƤò´Þ¤à options ¤È¤¤¤¦Ì¾Á°¤Î¥Õ¥¡¥¤¥ë¤òºîÀ®¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
\-d docs-filelist
\-use
\-splitindex
\-windowtitle 'Java 2 Platform v1.3 API Specification'
\-doctitle 'Java<sup><font size="-2">TM</font></sup> 2\\
Platform 5.0 API Specification'
\-header '<b>Java 2 Platform </b><br><font size="-1">5.0</font>'
\-bottom 'Copyright 1993-2000 Sun Microsystems, Inc. All Rights Reserved.'
\-group "Core Packages" "java.*"
\-overview /java/pubs/ws/1.5/src/share/classes/overview-core.html
\-sourcepath /java/pubs/ws/1.5/src/share/classes
.fi
.ft 1
.RE
.LP
°Ê²¼¤ÎÆâÍƤò´Þ¤à packages ¤È¤¤¤¦Ì¾Á°¤Î¥Õ¥¡¥¤¥ë¤òºîÀ®¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
com.mypackage1
com.mypackage2
com.mypackage3
.fi
.ft 1
.RE
.LP
¤½¤Î¤¢¤È¡¢¼¡¤Î¥³¥Þ¥ó¥É¤ò»ÈÍѤ·¤Æ javadoc ¤ò¼Â¹Ô¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc @options @packages
.fi
.ft 1
.RE
.LP
¥Ñ¥¹ÉÕ¤­¤Î°ú¿ô¥Õ¥¡¥¤¥ë¤ÎÎã
.LP
°ú¿ô¥Õ¥¡¥¤¥ë¤Ë¤Ï¡¢¥Ñ¥¹¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
¤¿¤À¤·¡¢¤½¤Î¥Õ¥¡¥¤¥ëÆâ¤Ë»ØÄꤵ¤ì¤¿¥Õ¥¡¥¤¥ë̾¤Ï¡¢
¸½ºß¤Îºî¶È¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¸«¤¿ÁêÂХѥ¹¤Ë¤Ê¤ê¤Þ¤¹¡£
¤Ä¤Þ¤ê¡¢²¼¤ÎÎã¤Î¾ì¹ç¤Ï¡¢path1 ¤ä
path2 ¤«¤é¸«¤¿ÁêÂХѥ¹¤Ç¤Ï¤¢¤ê¤Þ¤»¤ó¡£
.LP
.RS
.ft 3
.nf
% javadoc @path1/options @path2/packages
.fi
.ft 1
.RE
.LP
¥ª¥×¥·¥ç¥ó¤Î°ú¿ô¤ÎÎã
.LP
¼¡¤Ë¡¢javadoc ¥ª¥×¥·¥ç¥ó¤ËÂФ¹¤ë°ú¿ô¤À¤±¤ò°ú¿ô¥Õ¥¡¥¤¥ë¤Ë
³ÊǼ¤¹¤ëÎã¤ò¼¨¤·¤Þ¤¹¡£ ¤³¤³¤Ç¤Ï¡¢\-bottom ¥ª¥×¥·¥ç¥ó¤ò
Îã¤Ë¼è¤ê¾å¤²¤Þ¤¹¡£¤½¤Î¥ª¥×¥·¥ç¥ó¤Ë¤Ï¡¢
¤«¤Ê¤êŤ¤°ú¿ô¤ò»ØÄꤹ¤ë¤³¤È¤¬¤¢¤ë¤«¤é¤Ç¤¹¡£
¤Þ¤º¡¢¤³¤Î¥ª¥×¥·¥ç¥ó¤Î¥Æ¥­¥¹¥È°ú¿ô¤Ë¤Ê¤ë
¼¡¤Î¤è¤¦¤ÊÆâÍƤò´Þ¤à¡¢bottom ¤È¤¤¤¦Ì¾Á°¤Î
¥Õ¥¡¥¤¥ë¤òºîÀ®¤·¤Þ¤¹¡£
.LP
'<font size="-1"><a href="http://java.sun.com/cgi-bin/bugreport.cgi">
Submit a bug or feature</a><br><br>Java is a
trademark or registered trademark of
Sun Microsystems, Inc. in the US and other
countries.<br>Copyright 1993-2000 Sun
Microsystems, Inc. 901 San Antonio Road,<br>Palo
Alto, California, 94303, U.S.A.
All Rights Reserved.</font>'
.LP
¤½¤Î¤¢¤È¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Æ
.B javadoc
¥Ä¡¼¥ë¤ò¼Â¹Ô¤·¤Þ¤¹¡£
.LP
.TP 3
% javadoc \-bottom @bottom @packages
.LP
¤Þ¤¿¡¢°ú¿ô¥Õ¥¡¥¤¥ë¤ÎÀèƬ¤Ë
\-bottom ¥ª¥×¥·¥ç¥ó¤òÁȤ߹þ¤ó¤Ç¤ª¤±¤Ð¡¢¼¡¤Î¤è¤¦¤Ë¤·¤Æ¼Â¹Ô¤Ç¤­¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc @bottom @packages
.fi
.ft 1
.RE
.TP
.SH ¼Â¹Ô
.SS Javadoc ¤Î¼Â¹Ô
¥Ð¡¼¥¸¥ç¥óÈÖ¹æ -
.LP
javadoc ¤Î¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤Ï
.BR javadoc \-J\-version
¤ò»ÈÍѤ¹¤ë¤³¤È¤Ç³Îǧ¤Ç¤­¤Þ¤¹¡£
ɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¤Î¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤Ï½ÐÎÏ¥¹¥È¥ê¡¼¥à¤Ë
ɽ¼¨¤µ¤ì¤Þ¤¹¡£
¤³¤ì¤Ï \-quiet ¥ª¥×¥·¥ç¥ó¤Ç¥ª¥Õ¤Ë¤Ç¤­¤Þ¤¹¡£
.LP
¥×¥í¥°¥é¥à¤«¤éÍøÍѤǤ­¤ë public ¥¤¥ó¥¿¥Õ¥§¡¼¥¹ -
Java ¸À¸ì¤Ç½ñ¤«¤ì¤¿¥×¥í¥°¥é¥àÆ⤫¤é
.B javadoc
¥Ä¡¼¥ë¤ò¸Æ¤Ó½Ð¤·¤Þ¤¹¡£
¤³¤Î¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤Ï
.BR com.sun.tools.javadoc.Main
(javadoc ¤ÏºÆÆþ)
¤Ë¤¢¤ê¤Þ¤¹¡£ ¾ÜºÙ¤Ï¡¢¡Öɸ½à¥É¥Ã¥¯¥ì¥Ã¥È¡×
¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
\f3¥É¥Ã¥¯¥ì¥Ã¥È¤Î¼Â¹Ô\fP \-
²¼µ­¤ÎÀâÌÀ¤Ï¡¢É¸½à HTML ¥É¥Ã¥¯¥ì¥Ã¥È¤ò¸Æ¤Ó½Ð¤¹¤¿¤á¤Î¤â¤Î¤Ç¤¹¡£¥«¥¹¥¿¥à¥É¥Ã¥¯¥ì¥Ã¥È¤ò¸Æ¤Ó½Ð¤¹¤Ë¤Ï¡¢\-doclet ¤ª¤è¤Ó \-docletpath ¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Þ¤¹¡£ÆÃÄê¤Î¥É¥Ã¥¯¥ì¥Ã¥È¤ò¼Â¹Ô¤·¤¿´°Á´¤ÊÎã¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.na
¡Ö\f2Running the MIF Doclet\fP¡×
.fi
(http://java.sun.com/j2se/javadoc/mifdoclet/docs/mifdoclet.html#runningmifdoclet) ¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.SH "»ÈÍÑÎã"
.B javadoc
¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸Á´ÂΤËÂФ·¤Æ¼Â¹Ô¤¹¤ë¤³¤È¤â¡¢
¸Ä¡¹¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ËÂФ·¤Æ¼Â¹Ô¤¹¤ë¤³¤È¤â
¤Ç¤­¤Þ¤¹¡£³Æ¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Ï¡¢¤½¤ì¤¾¤ì¤Î
¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ËÂбþ¤¹¤ë¥Ç¥£¥ì¥¯¥È¥ê̾¤ò
»ý¤Á¤Þ¤¹¡£¼¡¤ÎÎã¤Ç¤Ï¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ï
.BR /home/src/java/awt/*java
¤Ë¤¢¤ê¤Þ¤¹¡£À¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê¤Ï
.BR /home/html
¤Ç¤¹¡£
.SS "1 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¥É¥­¥å¥á¥ó¥È²½"
¥Ñ¥Ã¥±¡¼¥¸¤ò¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¤Ë¤Ï¡¢¤½¤Î
¥Ñ¥Ã¥±¡¼¥¸¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë (*\f3.java\f1)
¤¬¡¢¥Ñ¥Ã¥±¡¼¥¸¤ÈƱ¤¸Ì¾Á°¤ò»ý¤Ä¥Ç¥£¥ì¥¯¥È¥ê
Æâ¤Ë¸ºß¤·¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
¥Ñ¥Ã¥±¡¼¥¸Ì¾¤¬Ê£¿ô¤Î¼±Ê̻Ҥǹ½À®¤µ¤ì¤Æ¤¤¤ë
(java.awt.color ¤Î¤è¤¦¤Ë¡¢³Æ¼±Ê̻ҤϥɥåȤÇ
¶èÀÚ¤é¤ì¤Æ¤¤¤ë) ¾ì¹ç¤Ï¡¢¸å³¤Î³Æ¼±Ê̻Ҥ¬²¼°Ì¤Î
¥µ¥Ö¥Ç¥£¥ì¥¯¥È¥ê¤ËÂбþ¤·¤Æ
¤¤¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó (java/awt/color ¤Ê¤É)¡£
1 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¤¿¤á¤ÎÊ£¿ô¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò¡¢
°Û¤Ê¤ë¾ì½ê¤Ë¤¢¤ë 2 ¤Ä¤Î¥Ç¥£¥ì¥¯¥È¥ê¥Ä¥ê¡¼¤Ëʬ¤±¤Æ
³ÊǼ¤¹¤ë¤³¤È¤â²Äǽ¤Ç¤¹
(
.BR src1/java/awt/color
¤È
.BR src2/java/awt/color
¤Ê¤É)¡£
¤¿¤À¤·¡¢¤½¤Î¾ì¹ç¤Ï¡¢\-sourcepath ¤Ë¤è¤Ã¤Æ¡¢
¤½¤ÎξÊý¤Î¾ì½ê¤ò»ØÄꤷ¤Ê¤±¤ì¤Ð¤Ê¤ê¤Þ¤»¤ó¡£
.LP
.B javadoc
¤ò¼Â¹Ô¤¹¤ë¤Ë¤Ï¡¢cd ¥³¥Þ¥ó¥É¤ò»È¤Ã¤Æ
¥Ç¥£¥ì¥¯¥È¥ê¤òÊѹ¹¤¹¤ë¤«¡¢
¤Þ¤¿¤Ï
.B \-sourcepath
¥ª¥×¥·¥ç¥ó¤ò»ÈÍѤ·¤Þ¤¹¡£
¤½¤ì¤¾¤ì¤ÎÎã¤ò¼¡¤Ë¼¨¤·¤Þ¤¹¡£
.TP 2
\(bu
.B ¥±¡¼¥¹ 1 - 1 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸¤«¤é¤Îµ¯Æ°¤òºÆµ¢Åª¤Ë¼Â¹Ô -
¤³¤ÎÎã¤Ç¤Ï javadoc ¤¬Ç¤°Õ¤Î¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¼Â¹Ô¤Ç¤­¤ë¤è¤¦¤Ë¡¢
.BR \-sourcepath
¤ò»ÈÍѤ·¡¢ºÆµ¢Åª½èÍý¤Î¤¿¤á¤Ë -subpackages (1.4 ¤Î¿·¥ª¥×¥·¥ç¥ó) ¤ò»ÈÍѤ·¤Þ¤¹¡£ ¤³¤ì¤Ï¡¢java ¤Î¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸ (
.BR java.net
¤ª¤è¤Ó
.BR java.lang
¤ò¥ë¡¼¥È¤È¤¹¤ë¥Ñ¥Ã¥±¡¼¥¸¤ò½ü¤¯) ¤ò½èÍý¤·¤Þ¤¹¡£
¤³¤ì¤Ë¤è¤Ã¤Æ
.BR java.lang.ref (
.BR java.lang
¤Î¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸) ¤¬
½ü³°¤µ¤ì¤ë¤³¤È¤ËÃí°Õ¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/html \-sourcepath /home/src \-subpackages java \-exclude java.net:java.lang
.fi
.ft 1
.RE
.LP
¾¤Î¥Ñ¥Ã¥±¡¼¥¸¥Ä¥ê¡¼¤ò½èÍý¤¹¤ë¤Ë¤Ï¡¢
.BR java:javax:org.xml.sax
¤Î¤è¤¦¤Ë¡¢¤½¤Î̾Á°¤ò
.BR \-subpackages
°ú¿ô¤ËÄɲä·¤Þ¤¹¡£
.TP 2
\(bu
.B ¥±¡¼¥¹ 2 - ¥ë¡¼¥È¥½¡¼¥¹¥Ç¥£¥ì¥¯¥È¥ê¤Ë°Ü¤Ã¤Æ¤«¤éÌÀ¼¨Åª¤Ê¥Ñ¥Ã¥±¡¼¥¸¤ò¼Â¹Ô -
´°Á´½¤¾þ¥Ñ¥Ã¥±¡¼¥¸¤Î
¿Æ¥Ç¥£¥ì¥¯¥È¥ê¤Ë°ÜÆ°¤·¤Þ¤¹¡£
¼¡¤Ë¡¢¥É¥­¥å¥á¥ó¥È²½¤¹¤ë
1 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò»ØÄꤷ¤Æ
.BR javadoc
¤ò¼Â¹Ô¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% cd /home/src/
% javadoc \-d /home/html java.awt java.awt.event
.fi
.ft 1
.RE
.TP 2
\(bu
.B ¥±¡¼¥¹ 3 - Ǥ°Õ¤Î¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¼Â¹Ô¡£¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ï 1 ¤Ä¤Î¥Ç¥£¥ì¥¯¥È¥ê¥Ä¥ê¡¼Æâ¤Ë¤¢¤ë - ¤³¤Î¥±¡¼¥¹¤Ç¤Ï¡¢¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¤¬¤É¤³¤Ç¤¢¤Ã¤Æ¤â¤«¤Þ¤¤¤Þ¤»¤ó¡£ ¥È¥Ã¥×¥ì¥Ù¥ë¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¿Æ¥Ç¥£¥ì¥¯¥È¥ê¤ò
.B \-sourcepath
¤Ë»ØÄꤷ¡¢¥É¥­¥å¥á¥ó¥È²½¤¹¤ë 1 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò»ØÄꤷ¤Æ¡¢
.B javadoc
¤ò¼Â¹Ô¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc -d /home/html -sourcepath /home/src java.awt java.awt.event
.fi
.ft 1
.RE
.TP 2
\(bu
.B ¥±¡¼¥¹ 4 - Ǥ°Õ¤Î¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¼Â¹Ô¡£¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ÏÊ£¿ô¤Î¥Ç¥£¥ì¥¯¥È¥ê¥Ä¥ê¡¼Æâ¤Ë¤¢¤ë - ¤³¤ì¤Ï¥±¡¼¥¹ 3 ¤È»÷¤Æ¤¤¤Þ¤¹¤¬¡¢¥Ñ¥Ã¥±¡¼¥¸¤¬Ê£¿ô¤Î¥Ç¥£¥ì¥¯¥È¥ê¥Ä¥ê¡¼¤Ë¸ºß¤·¤Þ¤¹¡£ ³Æ¥Ä¥ê¡¼¤Î¥ë¡¼¥È¤Ø¤Î¥Ñ¥¹¤ò
.B \-sourcepath
¤Ë»ØÄꤷ (¥³¥í¥ó¤Ç¶èÀÚ¤ë)¡¢¥É¥­¥å¥á¥ó¥È²½¤¹¤ë 1 ¤Ä°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò»ØÄꤷ¤Æ¡¢javadoc ¤ò¼Â¹Ô¤·¤Þ¤¹¡£ 1 ¤Ä¤Î¥Ñ¥Ã¥±¡¼¥¸¤Î¤¹¤Ù¤Æ¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤¬¡¢1 ¤Ä¤Î¥ë¡¼¥È¥Ç¥£¥ì¥¯¥È¥ê¤Î²¼¤Ë¸ºß¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡¢¤È¤¤¤¦¤³¤È¤Ï¤¢¤ê¤Þ¤»¤ó¡£¥½¡¼¥¹¥Ñ¥¹¤È¤·¤Æ»ØÄꤵ¤ì¤¿¾ì½ê¤Î¤É¤³¤«¤Ç¸«ÉÕ¤«¤ì¤Ð½½Ê¬¤Ç¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/html \-sourcepath /home/src1:/home/src2 java.awt java.awt.event
.fi
.ft 1
.RE
.LP
·ë²Ì: ¤É¤Á¤é¤Î¥±¡¼¥¹¤Ç¤â¡¢¥Ñ¥Ã¥±¡¼¥¸
.B java.awt
¤È
.B java.awt.event
¤Î public ¤ª¤è¤Ó protected
¤Ê¥¯¥é¥¹¤È¥¤¥ó¥¿¥Õ¥§¡¼¥¹¤òÂоݤˡ¢HTML ·Á¼°¤Î
¥É¥­¥å¥á¥ó¥È¤¬À¸À®¤µ¤ì¡¢»ØÄê
¤µ¤ì¤¿À¸À®Àè¥Ç¥£¥ì¥¯¥È¥ê (\f3/home/html\f1) ¤Ë HTML ¥Õ¥¡¥¤¥ë¤¬
Êݸ¤µ¤ì¤Þ¤¹¡£2 ¤Ä
°Ê¾å¤Î¥Ñ¥Ã¥±¡¼¥¸¤¬À¸À®¤µ¤ì¤ë¤Î¤Ç¡¢¥É¥­¥å¥á¥ó¥È¤Ï¡¢
¥Ñ¥Ã¥±¡¼¥¸¤Î¥ê¥¹¥È¡¢¥¯¥é¥¹¤Î¥ê¥¹¥È¡¢
¤ª¤è¤Ó¥á¥¤¥ó¥Ú¡¼¥¸¤Î 3 ¤Ä¤Î¥Õ¥ì¡¼¥à¤ò»ý¤Ä¤³¤È¤Ë¤Ê¤ê¤Þ¤¹¡£
.SS "1 ¤Ä°Ê¾å¤Î¥¯¥é¥¹¤Î¥É¥­¥å¥á¥ó¥È²½"
.B javadoc
¥Ä¡¼¥ë¤ò¼Â¹Ô¤¹¤ë 2 ÈÖÌܤÎÊýË¡¤Ï¡¢1 ¤Ä°Ê¾å¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë (
.B .java
) ¤òÅϤ¹¤³¤È¤Ç¤¹¡£
.B javadoc
¤Ï¡¢¼¡¤Î 2 ¤Ä¤Î¤É¤Á¤é¤«¤ÎÊýË¡¤Ç¼Â¹Ô¤Ç¤­¤Þ¤¹¡£
1 ¤Ä¤Ï¡¢(cd ¤Ë¤è¤Ã¤Æ) ¥Ç¥£¥ì¥¯¥È¥ê¤ò
Êѹ¹¤¹¤ëÊýË¡¡¢¤â¤¦ 1 ¤Ä¤Ï
.B .java
¥Õ¥¡¥¤¥ë¤Ø¤Î¥Ñ¥¹¤ò´°Á´»ØÄꤹ¤ëÊýË¡¤Ç¤¹¡£
ÁêÂХѥ¹¤Ï¡¢¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¤ÎÁêÂХѥ¹¤Ç¤¹¡£
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤òÅϤ·¤¿¾ì¹ç¡¢
.B \-sourcepath
¥ª¥×¥·¥ç¥ó¤Ï̵»ë¤µ¤ì¤Þ¤¹¡£
¥¢¥¹¥¿¥ê¥¹¥¯ (*) ¤Î
¤è¤¦¤Ê¥³¥Þ¥ó¥É¹Ô¥ï¥¤¥ë¥É¥«¡¼¥É¤ò»ÈÍѤ¹¤ë¤È¡¢
¥¯¥é¥¹¤Î¥°¥ë¡¼¥×¤ò»ØÄê¤Ç¤­¤Þ¤¹¡£
.TP 2
\(bu
.B ¥±¡¼¥¹ 1 ¥½¡¼¥¹¥Ç¥£¥ì¥¯¥È¥ê¤Ø¤Î°ÜÆ°:
.B .java
¥Õ¥¡¥¤¥ë¤Î¤¢¤ë¥Ç¥£¥ì¥¯¥È¥ê¤Ë°ÜÆ°¤·¤Þ¤¹¡£
¼¡¤Ë¡¢¥É¥­¥å¥á¥ó¥È²½¤¹¤ë 1 ¤Ä°Ê¾å¤Î
¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î̾Á°¤ò»ØÄꤷ¤Æ
.BR javadoc
¤ò¼Â¹Ô¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% cd /home/src/java/awt
% javadoc \-d /home/html Button.java Canvas.java Graphics*.java
.fi
.ft 1
.RE
.LP
.RS 2
¤³¤ÎÎã¤Ç¤Ï¡¢¥¯¥é¥¹ Button ¤È Canvas¡¢
¤ª¤è¤ÓÀèƬ¤¬ Graphics ¤Ç»Ï¤Þ¤ë¥¯¥é¥¹¤Î
HTML ·Á¼°¤Î¥É¥­¥å¥á¥ó¥È¤¬À¸À®¤µ¤ì¤Þ¤¹¡£
.BR javadoc
¤Î°ú¿ô¤È¤·¤ÆÅϤµ¤ì¤Æ¤¤¤ë¤Î¤Ï¡¢
¥Ñ¥Ã¥±¡¼¥¸Ì¾¤Ç¤Ï¤Ê¤¯¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Ê¤Î¤Ç¡¢
¥É¥­¥å¥á¥ó¥È¤Ï¡¢¥¯¥é¥¹¤Î¥ê¥¹¥È¤È
¥á¥¤¥ó¥Ú¡¼¥¸¤Î 2 ¤Ä¤Î¥Õ¥ì¡¼¥à¤ò»ý¤Ä¤³¤È¤Ë¤Ê¤ê¤Þ¤¹¡£
.RE
.TP 2
\(bu
.B ¥±¡¼¥¹ 2 ¥Ñ¥Ã¥±¡¼¥¸¤Î¥ë¡¼¥È¥Ç¥£¥ì¥¯¥È¥ê¤Ø¤Î°ÜÆ°:
¤³¤ì¤Ï¡¢Æ±¤¸¥ë¡¼¥ÈÆâ¤Ë¤¢¤ëÊ£¿ô¤Î¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸¤Î¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò¸Ä¡¹¤Ë
¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¾ì¹ç¤ËÊØÍø¤Ç¤¹¡£¥Ñ¥Ã¥±¡¼¥¸¤Î
¥ë¡¼¥È¥Ç¥£¥ì¥¯¥È¥ê¤Ë°ÜÆ°¤·¡¢³Æ¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò
¥ë¡¼¥È¤«¤é¤Î¥Ñ¥¹¤Ç»ØÄꤷ¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% cd /home/src/
% javadoc \-d /home/html java/awt/Button.java java/applet/Applet.java
.fi
.ft 1
.RE
.LP
.RS 2
¤³¤ÎÎã¤Ç¤Ï¡¢Button ¥¯¥é¥¹¤ª¤è¤Ó Applet ¥¯¥é¥¹
ÍѤΠHTML ·Á¼°¤Î¥É¥­¥å¥á¥ó¥È
¤¬À¸À®¤µ¤ì¤Þ¤¹¡£
.RE
.TP 2
\(bu
.B ¥±¡¼¥¹ 3 ¤¹¤Ù¤Æ¤Î¥Ç¥£¥ì¥¯¥È¥ê¤«¤é:
¤³¤Î¥±¡¼¥¹¤Ç¤Ï¡¢¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¤¬¤É¤Î
¥Ç¥£¥ì¥¯¥È¥ê¤Ç¤âÌäÂê¤Ï¤¢¤ê¤Þ¤»¤ó¡£
¥É¥­¥å¥á¥ó¥È²½¤¹¤ë
.B .java
¥Õ¥¡¥¤¥ë¤Ø¤ÎÀäÂХѥ¹¤Þ¤¿¤Ï
ÁêÂХѥ¹¤ò»ØÄꤷ¤Æ
.BR javadoc
¤ò¼Â¹Ô¤·¤Þ¤¹¡£
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/html /home/src/java/awt/Button.java /home/src/java/awt/Graphics*.java
.fi
.ft 1
.RE
.LP
.RS 2
¤³¤ÎÎã¤Ç¤Ï¡¢¥¯¥é¥¹
.B Button
¤ª¤è¤ÓÀèƬ¤¬
.BR Graphics
¤Ç»Ï¤Þ¤ë¥¯¥é¥¹¤Î HTML ·Á¼°
¤Î¥É¥­¥å¥á¥ó¥È¤¬À¸À®¤µ¤ì¤Þ¤¹¡£
.RE
.SS "¥Ñ¥Ã¥±¡¼¥¸¤È¥¯¥é¥¹¤Î¥É¥­¥å¥á¥ó¥È²½"
¥Ñ¥Ã¥±¡¼¥¸Á´ÂΤȸġ¹¤Î¥¯¥é¥¹¤òƱ»þ¤Ë¥É¥­¥å¥á¥ó¥È
²½¤Ç¤­¤Þ¤¹¡£¼¡¤Ë¼¨¤¹¤Î¤Ï¡¢¾å¤Ë¼¨
¤·¤¿ 2 ¤Ä¤ÎÎã¤òÁȤ߹ç¤ï¤»¤¿Îã¤Ç¤¹¡£
.B \-sourcepath
¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸¤Ø¤Î¥Ñ¥¹¤ËÂФ·¤Æ¤Ï»ÈÍѤǤ­¤Þ¤¹¤¬¡¢
¸Ä¡¹¤Î¥¯¥é¥¹¤Î¥Ñ¥¹¤ËÂФ·¤Æ¤Ï»ÈÍÑ
¤Ç¤­¤Þ¤»¤ó¡£
.LP
.RS
.ft 3
.nf
% javadoc \-d /home/html \-sourcepath /home/src java.awt /home/src/java/applet/Applet.java
.fi
.ft 1
.RE
.LP
¤³¤ÎÎã¤Ç¤Ï¡¢¥Ñ¥Ã¥±¡¼¥¸
.B java.awt
¤È¥¯¥é¥¹
.B Applet
¤Î HTML ·Á¼°¤Î¥É¥­¥å¥á¥ó¥È¤¬
À¸À®¤µ¤ì¤Þ¤¹¡£
.B javadoc
¤Ï¡¢Applet ¤Î¥Ñ¥Ã¥±¡¼¥¸Ì¾¤ò¡¢
.B Applet.java
¥½¡¼¥¹¥Õ¥¡¥¤¥ëÆâ¤Î¥Ñ¥Ã¥±¡¼¥¸¤ÎÀë¸À (Àë¸À¤¬¤¢¤ë¾ì¹ç) ¤«¤é·èÄꤷ¤Þ¤¹¡£
.SS "»ÈÍÑÎã"
.B javadoc
¥Ä¡¼¥ë¤Ë¤Ï¡¢Â¿¤¯¤ÎÊØÍø¤Ê¥ª¥×¥·¥ç¥ó¤¬¤¢¤ê¡¢
¤½¤ÎÃæ¤Î¤¤¤¯¤Ä¤«¤Ï¡¢¤Û¤«¤Î¥ª¥×¥·¥ç¥ó¤è¤ê¤â¤è¤¯
»È¤ï¤ì¤Þ¤¹¡£°Ê²¼¤Ï¡¢makefile ÊÑ¿ô¤ò»È¤Ã¤Æ Java ¥×¥é¥Ã¥È
¥Õ¥©¡¼¥à API ¾å¤Ç
.B javadoc
¥Ä¡¼¥ë¤ò¼Â¹Ô¤¹¤ë¤¿¤á¤Ë»È¤¦¸ú²ÌŪ¤Ê¥³¥Þ¥ó¥É¤Ç¤¹¡£
¤³¤³¤Ç¤Ï 180M ¥Ð¥¤¥È¤Î¥á¥â¥ê¤ò»ÈÍѤ·¤Æ¡¢
Java 2 Platform, Standard Edition, v1.2 ¤Ë
¸ºß¤¹¤ë¡¢Ìó 1500 ¸Ä¤Î public ¤ª¤è¤Ó protected
¥¯¥é¥¹¤Ë¤Ä¤¤¤Æ¥É¥­¥å¥á¥ó¥È¤òÀ¸À®¤·¤Þ¤¹¡£
.LP
Ʊ¤¸Îã¤ò 2 ²ó·ÇºÜ¤·¤Þ¤¹¡£ºÇ½é¤ÎÎã¤Ï¥³¥Þ¥ó¥É¹Ô¤«¤é¼Â¹Ô¤¹¤ë¤â¤Î¤Ç¡¢2 ÈÖÌܤÎÎã¤Ï Makefile ¤«¤é¼Â¹Ô¤¹¤ë¤â¤Î¤Ç¤¹¡£ ¥ª¥×¥·¥ç¥ó¤Î°ú¿ô¤ËÀäÂХѥ¹¤ò»ÈÍѤ·¤Æ¤¤¤ë¤¿¤á¡¢Ç¤°Õ¤Î¥Ç¥£¥ì¥¯¥È¥ê¤«¤é¤³¤Î
.B javadoc
¥³¥Þ¥ó¥É¤ò¼Â¹Ô¤Ç¤­¤Þ¤¹¡£
.SS ¥³¥Þ¥ó¥É¹Ô¤ÎÎã
¼¡¤Î¥³¥Þ¥ó¥É¹Ô¤ÎÎã¤Ï 900 ʸ»ú¤òĶ¤¨¤Æ¤¤¤ë¤¿¤á¡¢
DOS ¤Ê¤É¤Î¥·¥§¥ë¤Ë¤ÏÂ礭¤¹¤®¤Þ¤¹¡£
¤³¤ÎÀ©¸Â¤ò²óÈò¤¹¤ë¤Ë¤Ï¡¢¥³¥Þ¥ó¥É¹Ô
°ú¿ô¥Õ¥¡¥¤¥ë¤ò»ÈÍѤ·¤Þ¤¹¡£
¤Þ¤¿¤Ï¡¢¥·¥§¥ë¥¹¥¯¥ê¥×¥È¤òµ­½Ò¤·¤Þ¤¹¡£
.LP
.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 2 Platform 5.0 API Specification' \\
.fl
\-doctitle 'Java<sup><font size="\-2">TM</font></sup> 2 Platform 5.0 API Specification' \\
.fl
\-header '<b>Java 2 Platform </b><br><font size="\-1">5.0</font>' \\
.fl
\-bottom '<font size="\-1"><a href="http://java.sun.com/cgi\-bin/bugreport.cgi">Submit
.fl
a bug or feature</a><br><br>Java is a trademark or registered trademark of Sun Microsystems,
.fl
Inc. in the US and other countries.<br>Copyright 1993\-1999 Sun Microsystems, Inc.
.fl
901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A. All Rights Reserved.</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
.LP
¾åµ­¤Î¥³¥Þ¥ó¥É¤Ç¡¢packages ¤Ï¡¢
½èÍýÂоݤΥѥ屡¼¥¸Ì¾ (
.BR java.applett
.BR java.lang ¤Ê¤É) ¤¬
Æþ¤Ã¤Æ¤¤¤ë¥Õ¥¡¥¤¥ë¤Î̾Á°¤Ç¤¹¡£ ³Æ¥ª¥×¥·¥ç¥ó¤Î¡¢
ñ°ì°úÍÑÉä¤Ç°Ï¤Þ¤ì¤¿°ú¿ô¤ÎÆ⦤ˤϡ¢
²þ¹Ôʸ»ú¤òÁÞÆþ¤Ç¤­¤Þ¤»¤ó¡£ ¤¿¤È¤¨¤Ð¡¢
¤³¤ÎÎã¤ò¥³¥Ô¡¼¡õ¥Ú¡¼¥¹¥È¤¹¤ë¾ì¹ç¤Ï¡¢
.B \-bottom
¥ª¥×¥·¥ç¥ó¤«¤é²þ¹Ôʸ»ú¤òºï½ü¤·¤Æ¤¯¤À¤µ¤¤¡£
¤µ¤é¤Ë¡¢¤³¤Î¤¢¤È¤Î¡ÖÃí¡×¤â»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.SS Makefile ¤ÎÎã
¤³¤³¤Ç¤Ï¡¢GNU Makefile ¤ÎÎã¤ò¼¨¤·¤Þ¤¹¡£
Windows ¤Î Makefile ¤ÎÎã¤Ë¤Ä¤¤¤Æ¤Ï¡¢
.na
¡Ö\f2creating a makefile for Windows\fP¡×
.fi
(http://java.sun.com/j2se/javadoc/faq/index.html#makefiles) ¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.LP
.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 2 Platform v1.2 API Specification'
.fl
DOCTITLE = 'Java<sup><font size="\-2">TM</font></sup> 2 Platform v1.2 API Specification'
.fl
HEADER = '<b>Java 2 Platform </b><br><font size="\-1">v1.2</font>'
.fl
BOTTOM = '<font size="\-1"><a href="http://java.sun.com/cgi\-bin/bugreport.cgi">Submit
.fl
a bug or feature</a><br><br>Java is a trademark or registered trademark
.fl
of Sun Microsystems, Inc. in the US and other countries.<br>Copyright 1993\-1999
.fl
Sun Microsystems, Inc. 901 San Antonio Road,<br>Palo Alto, California, 94303, U.S.A.
.fl
All Rights Reserved.</font>'
.fl
GROUPCORE = '"Core Packages" "java.*:com.sun.java.*:org.omg.*"'
.fl
GROUPEXT = '"Extension Packages" "javax.*"'
.fl
SRCDIR = '/java/jdk/1.2/src/share/classes'
.fl
\fP
.fi
.LP
.LP
Makefile ¤Î°ú¿ô¤Ï¡¢Ã±°ì°úÍÑÉä¤Ç°Ï¤ß¤Þ¤¹¡£
.SS Ãí
.TP 2
\(bu
.B \-windowtitle
¥ª¥×¥·¥ç¥ó¤ò¾Êά¤¹¤ë¤È¡¢
.B Javadoc
¥Ä¡¼¥ë¤Ë¤è¤Ã¤Æ¥É¥­¥å¥á¥ó¥È¥¿¥¤¥È¥ë¤¬
¥¦¥£¥ó¥É¥¦¥¿¥¤¥È¥ë¤Ë¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£
.B \-windowtitle
¤Î¥Æ¥­¥¹¥È¤Ï¡¢´ðËÜŪ¤Ë
.B \-doctitle
¤ÈƱ¤¸¤Ç¤¹¡£¤¿¤À¤·¡¢HTML ¥¿¥°¤Ï»ÈÍѤ·¤Þ¤»¤ó¡£
HTML ¥¿¥°¤Ï¡¢¥¦¥£¥ó¥É¥¦¥¿¥¤¥È¥ë¤Ë¤½¤Î¤Þ¤Þ¤Î
¥Æ¥­¥¹¥È¤È¤·¤Æɽ¼¨¤µ¤ì¤Æ¤·¤Þ¤¤¤Þ¤¹¡£
.TP 2
\(bu
¤³¤ÎÎã¤Î¤è¤¦¤Ë
.B \-footer
¥ª¥×¥·¥ç¥ó¤ò¾Êά¤¹¤ë¤È¡¢
.B Javadoc
¥Ä¡¼¥ë¤Ë¤è¤Ã¤Æ¥Ø¥Ã¥À¥Æ¥­¥¹¥È¤¬
¥Õ¥Ã¥¿¤Ë¥³¥Ô¡¼¤µ¤ì¤Þ¤¹¡£
.TP 2
\(bu
¤³¤ÎÎã¤Ç¤ÏɬÍפ¢¤ê¤Þ¤»¤ó¤¬¡¢
.B \-classpath
¤ª¤è¤Ó
.BR \-link
¤â½ÅÍפʥª¥×¥·¥ç¥ó¤Ç¤¹¡£
.LP
.SH ¥È¥é¥Ö¥ë¥·¥å¡¼¥Æ¥£¥ó¥°
.SS °ìÈÌŪ¤Ê¥È¥é¥Ö¥ë¥·¥å¡¼¥Æ¥£¥ó¥°
.TP 2
\(bu
Javadoc FAQ - ¤è¤¯ÌäÂê¤È¤Ê¤ë¥Ð¥°¤ä
¥È¥é¥Ö¥ë¥·¥å¡¼¥Æ¥£¥ó¥°¤Î
¥Ò¥ó¥È¤Ï
.na
¡Ö\f2Javadoc FAQ\fP¡×
.fi
(http://java.sun.com/j2se/javadoc/faq/index.html#B) ¤Ë¤¢¤ê¤Þ¤¹¡£
.TP 2
\(bu
¥Ð¥°¤ª¤è¤ÓÀ©¸Â»ö¹à - ¤Þ¤¿¡¢¥Ð¥°¤Î°ìÉô¤Ï¡¢
.na
¡Ö\f2Important Bug Fixes and Changes\fP¡×
.fi
(http://java.sun.com/j2se/1.5.0/fixedbugs/index.html) ¤Ç¤â»²¾È¤Ç¤­¤Þ¤¹¡£
.TP 2
\(bu
¥Ð¡¼¥¸¥ç¥óÈÖ¹æ - ¥Ð¡¼¥¸¥ç¥óÈÖ¹æ¤ò»²¾È¤·¤Æ¤¯¤À¤µ¤¤¡£
.TP 2
\(bu
Í­¸ú¤Ê¥¯¥é¥¹¤À¤±¤ò¥É¥­¥å¥á¥ó¥È²½ -
javadoc ¤¬¥Ñ¥Ã¥±¡¼¥¸¤ò¥É¥­¥å¥á¥ó¥È²½¤¹¤ë¤È¤­¡¢
Í­¸ú¤Ê¥¯¥é¥¹Ì¾¤Ç¹½À®¤µ¤ì¤Æ¤¤¤ë¥Õ¥¡¥¤¥ë¤À¤±¤ò
Æɤ߹þ¤à¤è¤¦¤Ë¤Ê¤ê¤Þ¤·¤¿¡£
¥Õ¥¡¥¤¥ë̾¤Ë¥Ï¥¤¥Õ¥ó (-) ¤Ê¤É¤ò´Þ¤á¤ë¤³¤È¤Ç¡¢
javadoc ¤¬¥Õ¥¡¥¤¥ë¤ò²òÀϤ·¤Ê¤¤¤è¤¦¤Ë¤Ç¤­¤Þ¤¹¡£
.SS ¥¨¥é¡¼¤È·Ù¹ð
¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤ª¤è¤Ó·Ù¹ð¥á¥Ã¥»¡¼¥¸¤Ë¤Ï¡¢
¥Õ¥¡¥¤¥ë̾¤ÈÀë¸À¹Ô¤ËÂФ¹¤ë¹ÔÈֹ椬
´Þ¤Þ¤ì¤Þ¤¹¤¬¡¢doc ¥³¥á¥ó¥È¤ÎÆÃÄê¤Î
¹Ô¤ËÂФ¹¤ë¹ÔÈÖ¹æ¤Ï´Þ¤Þ¤ì¤Þ¤»¤ó¡£
.TP 2
\(bu
"error: cannot read: Class1.java" -
.B Javadoc
¥Ä¡¼¥ë¤Ï¸½ºß¤Î¥Ç¥£¥ì¥¯¥È¥ê¤Î
.BR Class1.java
¥¯¥é¥¹¤òÆɤ߹þ¤â¤¦¤È¤·¤Æ¤¤¤Þ¤¹¡£
¥¯¥é¥¹Ì¾¤Ï¡¢ÀäÂХѥ¹¤Þ¤¿¤ÏÁêÂХѥ¹¤Çɽ¼¨¤µ¤ì¤Þ¤¹¡£
¤³¤Î¾ì¹ç¡¢./Class1.java ¤ÈƱ¤¸¤Ç¤¹¡£
.LP
.SH "´Ä¶­"
.TP 20
.SB CLASSPATH
´Ä¶­ÊÑ¿ô¤Ï¡¢
.B javadoc
¤¬¥æ¡¼¥¶¥¯¥é¥¹¥Õ¥¡¥¤¥ë¤òõ¤¹¤È¤­¤Ë»È¤¦¡¢¥Ñ¥¹¤ò»ØÄꤷ¤Þ¤¹¡£´Ä¶­ÊÑ¿ô¤Ï¡¢
.B \-classpath
¥ª¥×¥·¥ç¥ó¤Ë¤è¤Ã¤Æ¥ª¡¼¥Ð¡¼¥é¥¤¥É¤µ¤ì¤Þ¤¹¡£¥Ç¥£¥ì¥¯¥È¥ê¤Ï
¥³¥í¥ó¤Çʬ³ä¤·¤Þ¤¹¡£¤¿¤È¤¨¤Ð¡¢
¼¡¤Î¤È¤ª¤ê¤Ç¤¹¡£
.RS 15
.sp 1n
.B .:/home/classes:/usr/local/java/classes
.RE
.br
.ne 11
.SH "´ØÏ¢¹àÌÜ"
.LP
.RS 3
.TP 2
o
javac
.TP 2
o
java
.TP 2
o
jdb
.TP 2
o
javah
.TP 2
o
javap
.TP 2
o
.fi
http://java.sun.com/j2se/javadoc/index.jsp
¤Î
.na
¡Ö\f2Javadoc Home Page\fP¡×
.TP 2
o
.fi
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
¤Î
.na
¡Ö\f2How to Write Doc Comments for Javadoc\fP¡×
.TP 2
o
¥¯¥é¥¹¥Ñ¥¹¤ÎÀßÄê
.TP 2
o
javac ¤È javadoc ¤¬¥¯¥é¥¹¤ò¸¡º÷¤¹¤ëÊýË¡ (tools.jar)
.RE
.LP
.LP
Javadoc ¤Ï¡¢Sun Microsystems, Inc ¤Î¾¦É¸¤Ç¤¹ (\f2javadoc\fP ¥³¥Þ¥ó¥É¼«ÂΤˤϾ¦É¸¥·¥ó¥Ü¥ë¤ÏÉÔÍ×)¡£