Doxygen 으로 코드보기 신동진 신수호
프로젝트 발주 ㅇㅇㅇ NoYea h 프로그래머 1 프로그래머 2
ㅇㅇㅇ NoYea h 프로그래머 1 프로그래머 2 class A { private: int a; int b; public: A(); ~A(); ……... };
ㅇㅇㅇ 프로그래머 1 프로그래머 2 class A { private: int a; int b; public: A(); ~A(); ……... }; ㅇㅇㅇ NoYea h
ㅇㅇㅇ NoYea h 프로그래머 1 프로그래머 2 class Mob { private: int health; int lvl; public: Mob(); ~Mob(); ……... };
ㅇㅇㅇ NoYea h 프로그래머 1 프로그래머 2 void setX(int x); class Mob { private: int health; int lvl; public: Mob(); ~Mob(); ……... }; ?
ㅇㅇㅇ NoYea h 프로그래머 1 프로그래머 2 void setX(int x); class Mob { private: int health; int lvl; public: Mob(); ~Mob(); ……... };
ㅇㅇㅇ NoYea h 프로그래머 1 프로그래머 2 class Mob { private: int health; // 피 int lvl; // 레벨 public: Mob(); // 생성 ~Mob(); // 소멸 ……... };
class Mob { private: int health; // 피 int lvl; // 레벨 public: Mob(); // 생성 ~Mob(); // 소멸 ……... }; class Map { private: int health; // 피 int lvl; // 레벨 public: Unit(); // 생성 ~Unit(); // 소멸 ……... }; class Bullet { private: int health; // 피 int lvl; // 레벨 public: Unit(); // 생성 ~Unit(); // 소멸 ……... }; class Building { private: int health; // 피 int lvl; // 레벨 public: Unit(); // 생성 ~Unit(); // 소멸 ……... }; class Unit { private: int health; // 피 int lvl; // 레벨 public: Unit(); // 생성 ~Unit(); // 소멸 ……... }; ㅇㅇㅇ NoYea h ?
Doxygen 으로 관리하자 Doxygen? – 특별한 주석으로 코드 자체를 문서화 – 함수, 변수 등등 각종 요소에 설명 그럼 무조건 그 문법으로 새로 작성해야 하나 ? – ㄴㄴ
Doxygen 문법 예시
Doxygen 활용 예시 HTML, LaTeX, XML 등등의 형식으로 출력 가능 Graphviz 라는 툴과 병용하면 … e817/docs/simpleRTS/index.htmlhttp://revreserver.ko.gl:2014/~laston e817/docs/simpleRTS/index.html
사용 환경 다양한 언어, 플랫폼에서 사용 가능 –C C++ C# Objective-C PHP Java Python Fortran 등등 –Windows Linux 에서 모두 가능 –Linux 에선 doxygen 명령어 한 번으로 쫘라락 생성 가능
문제점 일부 문법이 지원되지 않을 수 있음 –C++11 의 경우 스마트 포인터나, auto 자료형 등 일부 기능 미지원 – 다른 언어는 잘 모르겠지만 업데이트가 느릴 수 있음 –Graphviz 에 지장이 있지만 여전히 강력한 도구