Javadoc »ý¼º

Javadoc ¸¶¹ý»ç ¿­±â Javadoc »ý¼º ¸¶¹ý»ç¸¦ »ç¿ëÇÏ¿© Javadoc¸¦ »ý¼ºÇÒ ¼ö ÀÖ½À´Ï´Ù. Java JDK¿¡¼­ »ç¿ë °¡´ÉÇÑ javadoc.exe µµ±¸¿ë »ç¿ëÀÚ ÀÎÅÍÆäÀ̽ºÀÔ´Ï´Ù. Javadoc µµ±¸¿¡ ´ëÇÑ Àüü ¹®¼­¸¦ º¸·Á¸é Sun's Javadoc Tool ÆäÀÌÁö¸¦ ¹æ¹®ÇϽʽÿÀ.

ù ¹øÂ° ÆäÀÌÁö

À¯Çü ¼±ÅûçÇ×:

¿É¼Ç

¼³¸í

Javadoc¸¦ »ý¼ºÇÒ À¯Çü ¼±ÅÃ

¸ñ·Ï¿¡¼­ »óÀÚ¸¦ ¼±ÅÃÇϰųª ¼±ÅÃÀ» Ãë¼ÒÇØ¼­ JAR ÆÄÀÏ·Î ³»º¸³¾ À¯ÇüÀ» Á¤È®È÷ ÁöÁ¤ÇϽʽÿÀ. ÀÌ ¸ñ·ÏÀº Workbench ¼±ÅûçÇ×À¸·Î ÃʱâÈ­µË´Ï´Ù. Javadoc µµ±¸¸¦ ½ÇÇàÇÒ ¶§ ÇÑ ¹ø¿¡ ÇϳªÀÇ ÇÁ·ÎÁ§Æ® Ŭ·¡½º °æ·Î¸¸ »ç¿ëÇÒ ¼ö ÀÖÀ¸¹Ç·Î ÇÑ ¹ø¿¡ ÇÑ °³ÀÇ ÇÁ·ÎÁ§Æ®¸¸ ¼±ÅÃÇÒ ¼ö ÀÖ½À´Ï´Ù.

º¼ ¼ö ÀÖ´Â ±¸¼º¿ø¿¡ ´ëÇÑ Javadoc ÀÛ¼º

  • Private: ¸ðµç ±¸¼º¿øÀÌ ¹®¼­È­µË´Ï´Ù.
  • Package: default, protected ¶Ç´Â public °¡½Ã¼º ±¸¼º¿ø¸¸ ¹®¼­È­µË´Ï´Ù.
  • Protected: protected ¶Ç´Â public °¡½Ã¼º ±¸¼º¿ø¸¸ ¹®¼­È­µË´Ï´Ù.
  • Public: public °¡½Ã¼º ±¸¼º¿ø¸¸ ¹®¼­È­µË´Ï´Ù(±âº»°ª).


Ç¥ÁØ Doclet »ç¿ë

Ç¥ÁØ doclet(±âº»°ª)·Î Javadoc ¸í·ÉÀ» ½ÃÀÛÇÕ´Ï´Ù. 

  • ¼³¸í: Ç¥ÁØ doclet°¡ »ý¼ºµÈ ¹®¼­¸¦ ±â·ÏÇÒ ´ë»óÀ» ¼±ÅÃÇÕ´Ï´Ù. ´ë»óÀº doclet ƯÁ¤ ÀμöÀ̹ǷΠ»ç¿ëÀÚ Á¤ÀÇ doclet¸¦ »ç¿ëÇÒ ¶§´Â »ç¿ëÇÒ ¼ö ¾ø½À´Ï´Ù.


»ç¿ëÀÚ Á¤ÀÇ Doclet »ç¿ë

»ç¿ëÀÚ Á¤ÀÇ doclet¸¦ »ç¿ëÇÏ¿© ¹®¼­¸¦ »ý¼ºÇÕ´Ï´Ù. 

  • Doclet À̸§: docletÀÇ ±ÔÁ¤µÈ À¯Çü À̸§
  • Doclet Ŭ·¡½º °æ·Î: doclet Ŭ·¡½º¿¡ ÇÊ¿äÇÑ Å¬·¡½º °æ·Î


Ç¥ÁØ doclet Àμö

Ç¥ÁØ Doclet Àμö(Ç¥ÁØ doclet »ç¿ëÀÌ ¼±ÅõǾî ÀÖÀ» ¶§ »ç¿ë °¡´É)

¿É¼Ç

¼³¸í

¹®¼­ Á¦¸ñ

¹®¼­ Á¦¸ñÀ» ÁöÁ¤ÇÕ´Ï´Ù.
»ç¿ë ÆäÀÌÁö »ý¼º ¹®¼­¿¡ »ç¿ë ÆäÀÌÁö¸¦ Æ÷ÇÔÇÏ·Á´Â °æ¿ì ÀÌ ¿É¼ÇÀ» ¼±ÅÃÇϽʽÿÀ.
°èÃþ ±¸Á¶ Æ®¸® »ý¼º ¹®¼­¿¡ Æ®¸® ÆäÀÌÁö¸¦ Æ÷ÇÔÇÏ·Á´Â °æ¿ì ÀÌ ¿É¼ÇÀ» ¼±ÅÃÇϽʽÿÀ.

³×ºñ°ÔÀÌÅÍ Ç¥½ÃÁÙ »ý¼º

¹®¼­¿¡ Ž»öÁÙ(Çì´õ ¹× ¹Ù´Ú±Û)À» Æ÷ÇÔÇÏ·Á´Â °æ¿ì ÀÌ ¿É¼ÇÀ» ¼±ÅÃÇϽʽÿÀ.
»öÀÎ »ý¼º ¹®¼­¿¡ »öÀÎ ÆäÀÌÁö¸¦ Æ÷ÇÔÇÏ·Á´Â °æ¿ì ÀÌ ¿É¼ÇÀ» ¼±ÅÃÇϽʽÿÀ.
¹®ÀÚ¸¶´Ù »öÀÎ »ý¼º ¹®ÀÚ¸¶´Ù »öÀÎÀ» ÀÛ¼ºÇÕ´Ï´Ù. »öÀÎ »ý¼ºÀÌ ¼±ÅõǾî ÀÖÀ» ¶§ »ç¿ëÇÒ ¼ö ÀÖ½À´Ï´Ù. 
@author @author ű׸¦ ¹®¼­È­ÇÏ·Á´Â °æ¿ì ÀÌ ¿É¼ÇÀ» ¼±ÅÃÇϽʽÿÀ.
@version @version ű׸¦ ¹®¼­È­ÇÏ·Á´Â °æ¿ì ÀÌ ¿É¼ÇÀ» ¼±ÅÃÇϽʽÿÀ.
@deprecated @deprecated ű׸¦ ¹®¼­È­ÇÏ·Á´Â °æ¿ì ÀÌ ¿É¼ÇÀ» ¼±ÅÃÇϽʽÿÀ.
°ÅºÎµÈ ¸ñ·Ï ¹®¼­¿¡ °ÅºÎµÈ ÆäÀÌÁö¸¦ Æ÷ÇÔÇÏ·Á´Â °æ¿ì ÀÌ ¿É¼ÇÀ» ¼±ÅÃÇϽʽÿÀ. @deprecated ¿É¼ÇÀÌ ¼±ÅõǾî ÀÖÀ» ¶§ »ç¿ëÇÒ ¼ö ÀÖ½À´Ï´Ù.
Javadoc°¡ ¸µÅ©¸¦ ÀÛ¼ºÇÒ ÂüÁ¶ Ŭ·¡½º ¼±Åà ´Ù¸¥ À¯ÇüÀÌ ÂüÁ¶µÉ ¶§ Javadoc°¡ ¸µÅ©¸¦ ÀÛ¼ºÇØ¾ß ÇÏ´Â ´Ù¸¥ ¹®¼­¸¦ ÁöÁ¤ÇϽʽÿÀ. 
  • ¸ðµÎ ¼±ÅÃ: ´Ù¸¥ ¸ðµç ¹®¼­ À§Ä¡¿¡ ´ëÇÑ ¸µÅ© ÀÛ¼º
  • ¸ðµÎ Áö¿ì±â: ´Ù¸¥ ¹®¼­ À§Ä¡¿¡ ´ëÇÑ ¸µÅ© ÀÛ¼ºÇÏÁö ¾ÊÀ½
  • ±¸¼º: ÂüÁ¶µÈ JAR ¶Ç´Â ÇÁ·ÎÁ§Æ®ÀÇ Javadoc À§Ä¡ ±¸¼º
½ºÅ¸ÀÏ½ÃÆ® »ç¿ëÇÒ ½ºÅ¸ÀÏ½ÃÆ® ¼±ÅÃ

ÀÏ¹Ý Àμö

ÀÏ¹Ý Javadoc ¿É¼Ç:

¿É¼Ç

¼³¸í

°³¿ä

Javadoc°¡ ÁöÁ¤µÈ ÆÄÀÏ¿¡¼­ °³¿ä ¹®¼­ÀÇ ÅØ½ºÆ®¸¦ °Ë»öÇØ¾ß ÇÔÀ» ÁöÁ¤ÇÕ´Ï´Ù. À̰ÍÀº overview-summary.html¿¡ µÓ´Ï´Ù.

Ãß°¡ Javadoc ¿É¼Ç

¿©±â¿¡ ¿©·¯ °³ÀÇ Ãß°¡ ¿É¼Ç(»ç¿ëÀÚ Á¤ÀÇ doclet ¿É¼Ç, VM ¿É¼Ç ¶Ç´Â JRE 1.4 ȣȯ¼º ¿É¼Ç)À» Ãß°¡ÇÕ´Ï´Ù.
°ø¹éÀ» Æ÷ÇÔÇÏ´Â Àμö´Â µû¿ÈÇ¥ ¾È¿¡ ÀÖ¾î¾ß ÇÕ´Ï´Ù. html Äڵ带 ÁöÁ¤ÇÏ´Â ÀμöÀÇ °æ¿ì(¿¹: -header)   ¶Ç´Â "¸¦ »ç¿ëÇÏ°í °ø¹é°ú µû¿ÈÇ¥¸¦ »ç¿ëÇÏÁö ¸¶½Ê½Ã¿À.

ÀÌ Javadoc¸¦ Ant ½ºÅ©¸³Æ®·Î ³»º¸³»±â ¼³Á¤ ÀúÀå

¸¶¹ý»ç¸¦ »ç¿ëÇÒ ÇÊ¿ä¾øÀÌ ÁöÁ¤µÈ Javadoc ³»º¸³»±â¸¦ ¼öÇàÇÒ Ant ½ºÅ©¸³Æ®¸¦ ÀúÀåÇϵµ·Ï ÁöÁ¤ÇÕ´Ï´Ù. ±âÁ¸ÀÇ Ant ½ºÅ©¸³Æ®´Â ÀÌ ¸¶¹ý»ç¸¦ »ç¿ëÇÏ¿© ¼öÁ¤ÇÒ ¼ö ÀÖ½À´Ï´Ù(»ý¼ºµÈ Ant ½ºÅ©¸³Æ®ÀÇ ÄÁÅØ½ºÆ® ¸Þ´º¿¡¼­ Javadoc ¸¶¹ý»ç ¿­±â »ç¿ë).

ºê¶ó¿ìÀú¿¡¼­ »ý¼ºµÈ »öÀÎ ÆÄÀÏ ¿­±â »ý¼ºµÈ index.html ÆÄÀÏÀ» ºê¶ó¿ìÀú¿¡¼­ ¿±´Ï´Ù(Ç¥ÁØ doclet¸¦ »ç¿ëÇÒ ¶§¸¸ »ç¿ë °¡´É).

¿Ï·á¸¦ ´­·¯ Javadoc »ý¼ºÀ» ½ÃÀÛÇϽʽÿÀ. ´ë»óÀÌ ÇÁ·ÎÁ§Æ®ÀÇ Javadoc À§Ä¡ ÆäÀÌÁö¸¦ ±¸¼ºÇÑ À§Ä¡¿Í ´Ù¸¥ °æ¿ì ÇÁ·ÎÁ§Æ®ÀÇ Javadoc À§Ä¡¸¦ »õ ´ë»ó Æú´õ·Î ¼³Á¤ÇÒÁö ¹¯½À´Ï´Ù. ±×·¸°Ô ÇÏ¸é ¿ÜºÎ Javadoc ¿­±âÀÇ ¸ðµç È£ÃâÀÌ Áö±Ý ÀÛ¼ºÇÑ ¹®¼­¸¦ »ç¿ëÇÕ´Ï´Ù.

»õ ÇÁ·Î¼¼½º°¡ ½ÃÀÛµÇ°í ¹è°æ¿¡¼­ »ý¼ºÀÌ ¼öÇàµË´Ï´Ù. ÄÜ¼Ö º¸±â(â > º¸±â Ç¥½Ã > ÄܼÖ)¸¦ ¿­¾î »ý¼º ÁøÇà ¹× »óŸ¦ È®ÀÎÇϽʽÿÀ.

°ü·Ã Ÿ½ºÅ©

Javadoc ¹®¼­ ÀÛ¼º

°ü·Ã ÂüÁ¶

ÆÄÀÏ Á¶Ä¡
Javadoc À§Ä¡ Ư¼º