Javadoc »ý¼º 

 


´ç½ÅÀÇ ÇÁ·ÎÁ§Æ®¿¡¼­ Javadoc ¸¦ ÀÚµ¿ÀûÀ¸·Î »ý¼ºÇϱâ À§ÇØ, Tools |  Generate JavaDoc  ¸Þ´º Ç׸ñÀ» ¼±ÅÃÇϽʽÿÀ.

´ÙÀ½ ÆÐ³ÎÀÌ ¿­¸± °ÍÀÔ´Ï´Ù:

Àüü ÇÁ·ÎÁ§Æ®

¸¸ÀÏ ´ç½ÅÀÌ Àüü ÇÁ·ÎÁ§Æ®¸¦ À§ÇØ »ý¼ºµÈ Javadoc°¡ ÇÊ¿äÇϸé ÀÌ ¿É¼Ç ¹öưÀ» ¼±ÅÃÇϽʽÿÀ.
¸¸ÀÏ ´ç½ÅÀÌ Project View¿¡¼­ ¾î´À ƯÁ¤ÀÇ ÆÐŰÁöµµ ¼±ÅÃÇÏÁö ¾ÊÀ¸¸é ±×°ÍÀº µðÆúÆ®·Î È®Àε˴ϴÙ.

ÆÐŰÁö 'package_name'

¸¸ÀÏ Javadoc°¡ Ưº°ÇÑ ÆÐŰÁö¿¡¼­ »ý¼ºµÉ °ÍÀ̶ó¸é ÀÌ ¿É¼Ç ¹öưÀ» ¼±ÅÃÇϽʽÿÀ.

ƯÁ¤ÀÇ ÆÐŰÁö°¡ Project View¿¡¼­ ¼±ÅõǴø°¡, ¶Ç´Â ¸¸ÀÏ ÃÊÁ¡ÀÌ ¿¡µðÅÍ¿¡ ÀÖÀ¸¸é ±×°ÍÀº µðÆúÆ®·Î È®Àε˴ϴÙ.  ¸¸ÀÏ Include subpackages  ¿É¼ÇÀÌ Ã¼Å©µÇ¸é Javadoc ´Â ¼±ÅÃµÈ °ÍÀÇ ³»ºÎÀÇ ÆÐŰÁö¸¦ À§ÇØ »ý¼ºµË´Ï´Ù.

Ãâ·Â µð·ºÅ͸®

»ý¼ºµÈ ¹®¼­È­°¡ ÀúÀåµÉ °ÍÀÎ µð·ºÅ͸®¿¡ Ç® ÆÐ½º¸¦ ÁöÁ¤ÇϽʽÿÀ.  °æ·Î¸¦ ¼öµ¿À¸·Î ÀÔ·ÂÇϰųª, ellipsis ¹öưÀÇ µµ¿òÀ¸·Î ¿­¸± ¼ö ÀÖ´Â Select Path ´ÙÀ̾ó·Î±×¿¡¼­ ±×°ÍÀ» ¼±ÅÃÇÕ´Ï´Ù.  ÀÌ Çʵå·ÎºÎÅÍÀÇ µ¥ÀÌÅÍ´Â Javadoc's -d  ¸Å°³º¯¼ö·Î ÀüÇØÁú °ÍÀÔ´Ï´Ù


¸¸ÀÏ Á¤ÀÇµÈ µð·ºÅ͸®°¡ ´ç½ÅÀÇ ½Ã½ºÅÛÀÇ ¾È¿¡ Á¸ÀçÇÏÁö ¾ÊÀ¸¸é, IDEA¿¡ ÀÇÇØ ±×°ÍÀ» »ý¼ºÇϱâ À§ÇØ ´ç½Å¿¡°Ô ÇÁ·ÒÇÁÆ® µÉ  °ÍÀÔ´Ï´Ù.

¹üÀ§


½½¶óÀÌ´õÀÇ µµ¿òÀ¸·Î, Ŭ·¡½º¿Í ±¸¼º ¿ä¼Ò¿¡¼­ »ý¼ºµÈ ¹®¼­È­·Î ¾î´À °ÍÀ» Æ÷ÇÔÇØ¾ß ÇÏ´ÂÁö ÁöÁ¤ÇϽʽÿÀ:

private

-private Javadoc ¸Å°³º¯¼ö¿¡ ´ëÀÀÇÕ´Ï´Ù; ¼±ÅõǸé, ¸ðµç Ŭ·¡½º¿Í ¸â¹ö¸¦ Æ÷ÇÔÇÕ´Ï´Ù.

package

-package Javadoc ¸Å°³º¯¼ö¿¡ ´ëÀÀÇÕ´Ï´Ù; ¼±ÅõǸé, °³ÀÎÀûÀÎ °ÍÀ» Á¦¿ÜÇÏ°í ¸ðµç Ŭ·¡½º¿Í ¸â¹ö¸¦ Æ÷ÇÔÇÕ´Ï´Ù.

protected

-protected Javadoc ¸Å°³º¯¼ö¿¡ ´ëÀÀÇÕ´Ï´Ù; ¼±ÅõǸé, ¿À·ÎÁö ÆÛºí¸¯°ú º¸È£µÈ Ŭ·¡½º¿Í ¸â¹ö ¸¸À» Æ÷ÇÔÇÕ´Ï´Ù.

public

-public Javadoc ¸Å°³º¯¼ö¿¡ ´ëÀÀÇÕ´Ï´Ù; ¼±ÅõǸé, ¿À·ÎÁö ÆÛºí¸¯ Ŭ·¡½º¿Í ¸â¹ö ¸¸À» Æ÷ÇÔÇÕ´Ï´Ù.

±âº» ¿É¼Ç


Javadoc
»ý¼ºÀ» À§ÇØ ±âº» ¿É¼ÇÀ» Æ÷ÇÔÇÕ´Ï´Ù.  °¢ üũ ¹Ú½º´Â a Javadoc  ¸Å°³º¯¼ö¿¡ ºÎÇÕÇÕ´Ï´Ù: 

Generate hierarchy tree  

Ŭ·¡½º °èÃþÀÇ ½ºÀ§Ä¡ »ý¼ºÀÌ Ã¼Å© ¹Ú½º°¡ ¼±ÅõÇÁö ¾ÊÀ» ¶§, -notree ¸Å°³ º¯¼ö´Â Javadoc  ·Î ³Ñ°ÜÁý´Ï´Ù.

Generate navigator bar  

³×ºñ°ÔÀÌÅÍ ¹ÙÀÇ ½ºÀ§Ä¡ »ý¼ºÀÌ Ã¼Å© ¹Ú½º°¡ ¼±ÅõÇÁö ¾ÊÀ» ¶§, -nonavbar ¸Å°³ º¯¼ö´Â Javadoc  ·Î ³Ñ°ÜÁý´Ï´Ù.

Generate index  

¹®¼­È­ À妽ºÀÇ ½ºÀ§Ä¡ »ý¼ºÀÌ Ã¼Å© ¹Ú½º°¡ ¼±ÅõÇÁö ¾ÊÀ» ¶§, -noindex ¸Å°³ º¯¼ö´Â Javadoc  ·Î ³Ñ°ÜÁý´Ï´Ù.

Separate index per letter  

¸¸ÀÏ Generate index°¡ ¼±ÅÃµÇ¸é »ç¿ë °¡´ÉÇÕ´Ï´Ù;°¢ ¹®ÀÚ¸¦ À§ÇØ º°µµ »öÀÎ ÆÄÀÏÀ» »ý¼ºÇÕ´Ï´Ù¼±ÅõǸé -splitindex  ¸Å°³º¯¼ö´Â Javadoc·Î ³Ñ°ÜÁý´Ï´Ù.

ÀÌ Å±׸¦ ¹®¼­È­

»ý¼ºµÈ ¹®¼­È­·Î Æ÷ÇÔµÈ JavadocÀÇ ºÎ°¡Àû ºÎºÐÀ» ÁöÁ¤ÇϽʽÿÀ.  °¢ üũ ¹Ú½º´Â Javadoc ¸Å°³º¯¼ö¿¡ ÀÏÄ¡ÇÕ´Ï´Ù.

@use   

¹®¼­ Ŭ·¡½º¿Í ÆÐŰÁö »ç¿ë¼±ÅõǸé, -use Javadoc ¸Å°³º¯¼ö¿¡ ÀÏÄ¡ÇÕ´Ï´Ù.

@author  

@author ÆÐ·¯±×·¡ÇÁ¸¦ Æ÷ÇÔÇÕ´Ï´Ù; ¼±ÅõǸé, -author Javadoc ¸Å°³º¯¼ö¿¡ ÀÏÄ¡ÇÕ´Ï´Ù.

@version 

@versionÆÐ·¯±×·¡ÇÁ¸¦ Æ÷ÇÔÇÕ´Ï´Ù; ¼±ÅõǸé, -author Javadoc ¸Å°³º¯¼ö¿¡ ÀÏÄ¡ÇÕ´Ï´Ù.

@deprecated  

@deprecated Á¤º¸¸¦ Æ÷ÇÔÇÕ´Ï´Ù; ¸¸ÀÏ ¼±ÅõÇÁö ¾ÊÀ¸¸é, -nodeprecated ¸Å°³º¯¼ö´Â Javadoc·Î

³Ñ°ÜÁý´Ï´Ù.

deprecated list 

¸¸ÀÏ @deprecated °¡ ¼±ÅÃµÇ¸é °¡´ÉÇÕ´Ï´Ù; deprecated ¸ñ·ÏÀÌ »ý¼ºµË´Ï´Ù; ¸¸ÀÏ ¼±ÅõÇÁö ¾ÊÀ¸¸é –nodeprecatedlist ¸Å°³º¯¼ö´Â Javadoc·Î ³Ñ°ÜÁý´Ï´Ù.

´Ù¸¥ ¸Å°³ º¯¼ö

´ç½ÅÀÌ ¾Æ¸¶µµ ÇÊ¿äÇÏÁö¸¸ IDEA UI ¿¡¼­ ¹Ý¿µµÇÁö ¾ÊÀº ´Ù¸¥ Javadoc ¸Å°³º¯¼ö¸¦ ÁöÁ¤ÇϽʽÿÀ.

ÃÖ´ë Èü Å©±â(Mb)

Javadoc ½ÇÇàÇϱâ À§ÇÑ ÀÚ¹Ù VM¿¡ ÀÇÇØ »ç¿ëµÉ ÃÖ´ë Èü Å©±â¸¦ Mb´ÜÀ§·Î ÁöÁ¤ÇϽʽÿÀ

ºê¶ó¿ìÀú¿¡¼­ »ý¼ºµÈ ¹®¼­ ¿­±â

¸¸ÀÏ ´ç½ÅÀÌ IDEA °¡ ºê¶ó¿ìÀú¿¡¼­ »ý¼ºµÈ Javadoc¸¦ ÀÚµ¿ÀûÀ¸·Î ¿­±â ¹Ù¶ó¸é ÀÌ Ã¼Å© ¹Ú½º¸¦ ¼±ÅÃÇϽʽÿÀ.


ÀÌ Ã¼Å© ¹Ú½º¸¦ ¼±ÅÃÇÒ ¶§, ´ç½ÅÀÇ ºê¶ó¿ìÀú·ÎÀÇ °æ·Î°¡ File | Settings: IDE Settings ´ÙÀ̾ó·Î±×,  General  ´ÙÀ̾ó·Î±× (applicable for Linux/Unix¿Í Mac OS¿¡ ´ëÇØ Àû¿ëÇÒ ¼ö ÀÖ´Â)¿¡¼­ Á¤ÀǵǾú´ÂÁö È®ÀÎÇϽʽÿÀ.