Doclet�ɂ����

�쐬 2002/11/27
�X�V 2002/11/28

�g���Ă�l�����āA�ʔ������Ȃ̂Œ��ׂĂ݂܂����B

• JavaDoc
• Doclet
• Taglet

Doclet���āH

Doclet��JavaDoc�쐬�Ɏg�p�����v���O�����ł��B ���ʂ�javadoc�����ꍇ��Sun�̕W��Doclet���g���܂����A -doclet�I�v�V�����Ɏ����ō����Doclet��n�����ƂŁA JavaDoc�̕\���`�����J�X�^�}�C�Y�ł��܂��B

�P��JavaDoc�̕\���`�����J�X�^�}�C�Y�������̂ł���΁A �W��Doclet�̃\�[�X�Ɏ��������̂������炵���ł� (JavaDoc���̂��ĕ��G�Ȃ̂�)�B

Doclet�쐬�ɂ�DocletAPI���g���܂��B JavaDoc�R�����g�Ɋւ��郊�t���N�V����API�݂����Ȋ����ł��B

�Ǝ�Doclet��JavaDoc�o�͈ȊO�ɂ��A �R�[�f�B���O���[���`�F�b�N�⃁�\�b�h���v�Z(?)�Ȃ� ���낢��g�����͂���悤�ł��B

�Q�l�����́A�Ƃ肠����JDK�h�L�������g�ɐ������ڂ��Ă܂����B
�H�菇�FSDK�̃c�[��->Javadoc(Win32)->Javadoc�̃h�N���b�g->Javadoc�̃h�N���b�g

����Ă݂�

�Ƃ肠�����h�L�������g�̃T���v�������Ȃ������Ă݂܂����B
MyDoclet.java(Doclet�T���v��)
MyClass.java(javadoc�ɂ�����N���X�T���v��)

Doclet�N���X�͓��ɉ������p��������Ă킯�ł��Ȃ��A

    public static boolean start(RootDoc root) {
	//...

�R���p�C��

Doclet�N���X�̃R���p�C���A���s�ɂ�tools.jar���N���X�p�X�Ɋ܂߂�K�v������܂��B

���s

DOS�R�}���h�v�����v�g�ł̎��s��

javadoc -doclet hoge.MyDoclet -docletpath classes 
-classpath classes;%JAVA_HOME%\lib\tools.jar -sourcepath src -private aaa

hoge.MyDoclet�h�N���b�g���g����aaa.MyClass��javadoc���Ă��܂��B

Doclet�N���X�� -docletpath�I�v�V�����Ńh�N���b�g�N���X�p�X�Ɋ܂߂�K�v������܂�(�N���X�p�X����_��)�B

���s����

C:\apps\eclipse\workspace\doclet01>javadoc -doclet hoge.MyDoclet -docletpath clsses -classpath classes;C:\apps\j2sdk1.4.0_01\lib\tools.jar -sourcepath src -private aaa
�p�b�P�[�W aaa �̃\�[�X�t�@�C����ǂݍ���ł��܂�...
Javadoc �����\�z���Ă��܂�...
[MyClass]
�N���X��
@author:Muimin
[aaa]
�t�B�[���h��
[hoge]
���\�b�h��
@hoge:p1 �ق���
@return:�����茌
@param:p1 �p�����^

�������Ė��m�ȖڕW���Ȃ��̂ŁA�Ƃ肠��������Ȃ���B

Taglet

Taglet�Ƃ́H

Taglet��(�W��Doclet�ŕ��ʂ�)JavaDoc����Ƃ��A�V����Tag��JavaDoc�ɕ\������̂Ɏg���܂��B JavaDoc�̃J�X�^�}�C�Y�ōł����肻���Ȃ��͓̂Ǝ��^�O�̒lj��Ȃ̂ŁA ����ɊȒP�ɑΉ����邽�߂ɍ��ꂽ�d�g�݂ł�(���Ԃ�)�B

Doclet�̐����ƈꏏ�ɂ̂��Ă��̂ŁA������Ƃ����g���Ă݂܂����B

����Ă݂�

ROSE��@roseid��JavaDoc�ŕ\�����Ă݂܂� (���������̊��ɒ񋟂���Ă����ł����A�܂��A�ȒP�Ȏ����Ƃ��č���Ă݂܂����B �قƂ��JDK�T���v���܂�)�B
RoseIdTaglet.java(Taglet�T���v��)
MyClass2.java(Taglet�ɂ�����N���X�T���v��)

���s

�W��Taglet���g���̂ŁAtools.jar���N���X�p�X�Ɋ܂߂�K�v�͂Ȃ��悤�ł��B -taglet��-tagletpath�I�v�V�������w�肵�܂��B

javadoc -d doc -taglet hoge.RoseIdTaglet -tagletpath classes 
-classpath classes;%JAVA_HOME%\lib\tools.jar -sourcepath src aaa

���s����

����Ȋ���(MyClass2.html)��JavaDoc ���o���܂����B

�ƂĂ��ȒP�ł��ˁB Taglet�̓����o�[�W������JDK1.4�Ə����Ă�̂ŁA�̂�JDK�ł͎g���Ȃ����ȁB

�Ȃ��A��L�Ɠ������Ƃ�-tag�I�v�V����(-tag roseid:a:"roseid:") �ʼn”\�Ȃ̂ŁATaglet�͂���������ƋÂ肽���Ƃ��Ɏg���̂��낤�Ǝv���܂��B