���� Javadoc

�}�� Javadoc ���FJavadoc �������F�i���z���� Javadoc�C ���O Java JDK �Ҵ��Ѥ� javadoc.exe �u�㪺�ϥΪ̤����C �гy�X Sun's Javadoc Tool �����A�H���o Javadoc �u�㪺������C

����

�����ﶵ�G

�ﶵ

����

Javadoc ���O

���w�ΨӲ��� javadoc �����O�C

����n���� Javadoc ������

�b�M�椤�A�Ŀ�βM���Ŀ�ءA�H���T���w�n�ץX�������C�o���M��|�ھڤu�@�x������ܶ��Ӱ_�l�]�w�C

���]�� visibility �������إ� Javadoc
  • Private�G�N�O���Ҧ�����
  • Package�G�u�O���]�� default�Bprotected �� public visibility ������
  • Protected�G�u�O���]�� protected
  • Public�G�u�O���]�� public visibility �������]�o�O�w�]�ȡ^

�ϥμз� doclet

�H�з� doclet �Ұ� Javadoc ���O�]�w�]�ȡ^

  • �ت��a�G�п���@�ӥت��a�A�H�K���з� doclet �N�Ҳ��ͪ����g��o�̡C�ت��a�O doclet �S�w���޼ơA�]���p�G�z�ϥΦۭq doclet�A�N���|�ҥΡC


�ϥΦۭq doclet

�ϥΦۭq doclet �Ӳ��ͤ��

  • Doclet �W���Gdoclet �����������W��
  • Doclet ���O���|�G doclet ���O�һݪ����O���|

�з� doclet �޼�

�з� Doclet �޼ơ]������F�ϥμз� doclet �ɴN�i�ϥΡ^�G

�ﶵ

����

�����D

 ���w��󪺼��D�C
���͡u�ϥΡv���� �p�G�z�Q����󤤥]�t�@�ӡu�ϥΡv�����A�п���o�ӿﶵ�C
���Ͷ��h�𪬵��c �p�G�z�Q����󤤥]�t�@�ӡu�𪬵��c�v�����A�п���o�ӿﶵ�C

���;������C

 �p�G�z�Q����󤤥]�t�@�Ӿ����C�]���Y�P�Щ��^�A�п���o�ӿﶵ�C
���ͯ��� �p�G�z�Q����󤤥]�t�@�ӡu���ޡv�����A�п���o�ӿﶵ�C
�̦r���Ϲj���� �C�Ӧr���U�ؤ@�ӯ��ޡC������F���ͯ����ɡA���ܤw�ҥΡC 
@author �p�G�z�Q�ĩ� @author �ХܡA�п���o�ӿﶵ�C
@version �p�G�z�Q�ĩ� @version �ХܡA�п���o�ӿﶵ�C
@deprecated �p�G�z�Q�ĩ� @deprecated �ХܡA�п���o�ӿﶵ�C
�w�^�O���M�� �p�G�z�Q����󤤥]�t�@�ӡu�w�^�O�v�����A�п���o�ӿﶵ�C ������F @deprecated �ﶵ�A�N���ܤw�ҥΡC
������Ӳ����쵲���ѷӫO�s�ɩM�M�� ���X�����ѷӨ�L�����ɡAJavadoc ���إߩM��L���Ǥ���쵲�C
  • ����G�إߩM��L�Ҧ�����m�����쵲
  • �����M���G���إߩM��L����m�����쵲
  • �t�m�G�t�m�ҰѷӤ� JAR �αM�ת� Javadoc ��m�C
�˦��� ����ҭn�ϥΪ��˦���

�@��޼�

�@�� Javadoc �ﶵ�G

�ﶵ

����

���[

���X Javadoc ���q�Ҵ��Ѫ��ɮפ��^�����[��󪺤�r�C �N��b overview-summary.html �ɤ��C

VM �ﶵ

�b�o�̷s�W����ƥت��B�~ VM �ﶵ�C

��L�� Javadoc �ﶵ

�b�o�̷s�W��L�ﶵ�]�ƶq�����^�G�ۭq doclet �ﶵ�� JRE 1.4 �ۮe�ʿﶵ�C
�Ъ`�N�A�p�G�޼Ƥ��t���Ů�A�h�����A�W�޸��C�Y�����w HTML �{���X���޼ơ]�p -header�^�A�Шϥ� &  �� &"�A�H�קK�ϥΪŮ�P�޸��C

JRE �{���X�ۮe��

Javadoc �u��ҭn������ JRE �{���X�ۮe�ʡC

�N�o�� Javadoc �ץX���]�w�x�s�� Ant Script

�x�s�@�� Ant Script�A�H�ΨӰ�����w�� Javadoc �ץX�A�Ӥ��Ψ���F�C �z�i�ϥγo�Ӻ��F�ӭק�{���� Ant Script �]�q�Ҳ��ͤ� Ant Script �W���ֳt�\����A�ϥΡu�}�� Javadoc�v���F�^

�b�s�������}�Ҳ��ͪ������� �b�s�������}�ҩҲ��ͪ� index.html �ɡ]�u���b�ϥμз� doclet �ɤ~��Ψ�^

���U�����H�}�l���� Javadoc�C �p�G�ت��a�M�M�פ� �uJavadoc ��m�v�������Ұt�m����m���P�A�h�|�߰ݱz�O�_�n�N�M�ת� Javadoc ��m�]���s���ت��a��Ƨ��C ���p�����ɡA�Ҧ����u�}�ҥ~�� Javadoc�v�I�s�@�~�N�|�ϥγo�ɩҫت����C

�|�Ұʷs�{�ǡA�æb�I���U���沣�ͧ@�~�C �p�G�n�d�ݲ��ͧ@�~���i�׻P���A�A�ж}���u�D���x�v���� �]�u�����v>�u��ܵ��ϡv>�u�D���x�v�^�C

�����ѷ�

�ɮװʧ@
Javadoc ��m���e