�V�g�b�v�y�[�W���@�b�@�s����
�\�[�X�R�[�h����h�L�������g��Doxygen��������
LastUpdate : 13/01/02
JavaDoc�I�Ȃ��Ƃ�C++�ł���낤�A�Ƃ����b�ł��B
�����AJavaDoc�Ő�������HTML�����Ė��ɗ��������Ƃ����܂�L��܂��A�R�����g�������ۂ̓���I�ȏ����Ƃ��Ă͖��ɗ��Ǝv���܂��B
������
�͂��߂�
Doxygen�̃C���X�g�[��
�R�����g�̏���
�h�L�������g������
�ڍׂ͂�����(http://www.doxygen.jp/)���Q�ƁB
���{��T�C�g������̂ŁA���ɕ֗��ł��i�������I�j�B�܂��A���ɑ��@�\�B
���ہA�g����悤�ȃh�L�������g�ɂ��邩���Ȃ����̓R�����g�������l���悾���E�E�E�B
���̃y�[�W�ł́A�R�����g�̊�{�I�ȏ��������T���v���Ƃ��Ă�������x�ɗ��߂�B
�܂��ADoxygen�́A�R�����g�̏������������̃^�C�v����I�ׂ邪�i���̒���JavaDoc�݂����ɂ���I����������j�AJavaDoc���C�N�Ɏg���邱�Ƃ�ڎw���B
�o�[�W������1.8.3���g�p���܂�(13/01/02���_�ōŐV��)�B
�����ihttp://www.stack.nl/~dimitri/doxygen/download.html�j����A�_�E�����[�h���s���B
�\�[�X����r���h����菇������݂��������A�ʓ|�Bwindows�̏ꍇ�̓o�C�i�����g���̂��������ƁB
�C���X�g�[���E�B�U�[�h���n�܂�̂ŁA����ɏ]���C���X�g�[���B
�C���X�g�[����A�C���X�g�[���f�B���N�g����bin\doxywizard.exe���N������BGUI�ő���\�ł��B
�T���v�����ȉ��Ɏ����܂��B
JavaDoc�`���ŃR�����g���L�q���܂����B�R�����g�̒���HTML���L�q���邱�Ƃ��\�ł��B
main.cpp |
/** * @file main.cpp * @brief main�����`���Ă��܂��B<br> * �ɂ��ɂ��B * * �v���O�����̃G���g���|�C���g���`���Ă��܂��B<br> * �O��ɋs������āA�ڍׂ��L�q���܂��B * @par �����1�̃p���O���t���`�ł��܂��A * �ڍׂ���[�[�[�[�[�[�[�[�[�[�[�[�[�[�[�[�[�[�[�[�[�[<br> * ���Ƃ����ɋL�q���܂��B * @par ������`�ł��܂��B * ���Ђ�����������������������������������������<br> * ����� * @date 2013/01/02 �V�K�쐬�I * @date ���� �쐬�����idate������Ƃ����ē��t�������K�v�͂Ȃ��B�j * @author ��҂̖��O�������܂� */ #include "Doc.h" /** * ���C������. * @param argc �����̐� * @param argv �����̒l�̔z�� * @return ���^�[���R�[�h */ int main(int argc, char** argv) { // ���������s���� myNamespace::Doc obj(10); obj.doWork(); } |
Doc.h |
/** * @file Doc.h * @brief �����ɗv���L�q���܂��B<br> * �ނɂ�ނɂ�ނɂ�ނɂ�ނɂ�ނɂ�B * @author ��҂̖��O�������܂� * @date �N����������<br> * �쐬���� * @date ���̓�<br> * ���������x�n�I */ namespace myNamespace { /** * �N���X�����̗v��������ɏ����B<br> * �ނɂ�ނɂ�ނɂ�. */ class Doc { public: /** �f�t�H���g�R���X�g���N�^. */ Doc() {} /** * �R���X�g���N�^. * @param num ���w�肷��(�����̐���) */ Doc(int num) { this->num = num; } /** * �R�s�[�R���X�g���N�^. * @param doc �R�s�[���I�u�W�F�N�g */ Doc(Doc& doc) { setNum(doc.getNum()); } /** �f�B�X�g���N�^. */ virtual ~Doc() {} /** ANIMAL�̐�������� */ enum ANIMAL { /** �L. */ CAT, /** ��. */ DOG, /** ��. */ BIRD }; /** * �����o���̃R�����g. * @return ���[�v�������s������(�߂�l�̐���) */ int doWork(); /** @return �����ŕێ����Ă���ԍ� **/ int getNum() const { return num; } /** @param num �ԍ� */ void setNum(int num) { this->num = num; } private: /** �����ŕێ����Ă���ԍ��i�����o�ϐ��ւ̃R�����g�j */ int num; }; } |
Doc.cpp |
/** * @file Doc.cpp * @brief Doc�N���X�̎��� * @author ��҂̖��O�������܂� */ #include <iostream> #include "Doc.h" namespace myNamespace { /* * �d�������܂��I. * @return �߂�l�����I */ int Doc::doWork() { // �L�̖������o�� int i; for (i=0; i<getNum(); i++) { std::cout << "�ɂ��\n"; } return i+1; } } |
�JavaDoc�ƈقȂ�Ƃ��낪����܂����i�t�@�C���w�b�_�̕����Ƃ��j�A��������JavaDoc���o�ŋL�q�ł��܂��B
���ӂ������̂��A�N���X�̃����o���̐錾�ƒ�`��������Ă���ꍇ�ł��iinline�ɂ������ȊO�͕������Ǝv���܂����B�B�B�j�B������/**�Ŏn�܂�R�����g�����Ă��܂��ƁA�������̂��Q�o�͂���Ă��܂��l�q�ł��B���̂��߁ADoc.cpp�ł�/**�ł͂Ȃ��A/*�ŃR�����g���n�߂Ă��܂��i/*�̏ꍇ�̓h�L�������g�ɏo�͂���Ȃ��j
�ȉ��ɁA�o�͂��ꂽ�h�L�������g�̃L���v�`�����ڂ��Ă����܂��B�������̃I�v�V�����̐ݒ�Ŏ�o�͂���鍀�ڂɈႢ������܂��B
�܂��A�t�@�C���̈ꗗ�B�T�v�����������o�͂���܂��B
Doc.cpp�̃h�L�������g�BDoc.cpp�ɂ̓����o���̒�`���������ĂȂ��B����ƁA�h�L�������g�͈ȉ��̂��̂����o�Ȃ��݂����B
Doc.h�̃h�L�������g
main.cpp�̃h�L�������g
�N���X�ꗗ�B�l�[���X�y�[�X���ɕ\�������炵���B
�C���X�g�[���f�B���N�g���́ubin�v�f�B���N�g���̒��ɂ���udoxywizard.exe�v���N�����܂��B
����菇�̃L���v�`�������������Ă����܂��B
�� ����菇�̒��ŕ����R�[�h�̐ݒ�����Ă��邪�A����͌��̃\�[�X�̕����R�[�h��CP932������A�ݒ�����ׂ�CP932�ɂ��Ă��܂��B
��
��
��
��
��
��
��