설치VS.Net 2003 http://www.codeproject.com/KB/macros/kingstools.aspx
2003용 Kingstool 은 이 링크로 들어가 Download Installer를 누르면 Sign-up을 하라고 합니다.
Name, Email, Password 만 입력하면 바로 가입이 되어 다운로드가 가능합니다.
2005부터는 Doxycomment 라는 이름으로 바뀌었다고 합니다.
VS.Net 2005 http://nchc.dl.sourceforge.net/sourceforge/doxycomment/doxycomment_0_4_3_setup.msi
VS.Net 2008 http://jaist.dl.sourceforge.net/sourceforge/doxycomment/DoxyComment-VS2008-Setup.msi
(2008용 Kinstool 은 베타 버전입니다.)
2003용 Kingstool 사용법에 대해서만 설명하겠습니다.
설치가 완료되면 닷넷 2003을 켜봅니다. 그러면 도구(Tool) 탭 제일 위에 Kings Tools 가 생깁니다.
각 메뉴에 대한 설명을 하겠습니다.
- Run Doxygen : Doxygen, 문서화를 시키기 위해 Doxygen을 실행합니다. 주요 내용이므로 밑에서 한 번 더 설명합니다.
- Insert Doxygen Comments : 문서에 보일 코멘트를 입력할 수 있게 해줍니다. 예를 보여드리겠습니다.
class cMatrixManager
{
private:
std::vector<cMatrix> m_vMatrix;
int m_iCount;
private:
cMatrixManager();
public:
static cMatrixManager& getInstance();
void Push(cMatrix m);
void Pop();
cMatrix getMatrix();
};
행렬들을 관리하는 매니저 클래스입니다.
class cMatrixManager 오른쪽에 커서를 깜박이게 두고서 Insert Doxygen Comments 를 누르면
클래스 위에 이런 식으로 주석이 자동으로 달립니다.
/**
* \ingroup 3D API
*
*
* \par requirements
* win98 or later\n
* win2k or later\n
* MFC\n
*
* \version 1.0
* first version
*
* \date 2009-01-09
*
* \author kimhyunsu
*
* \par license
* This code is absolutely free to use and modify. The code is provided "as is" with
* no expressed or implied warranty. The author accepts no liability if it causes
* any damage to your computer, causes your pet to fall ill, increases baldness
* or makes your car start emitting strange noises when you start it up.
* This code has no bugs, just undocumented features!
*
* \todo
*
* \bug
*
*/
함수 선언문의 오른쪽 끝에서도 Insert... 를 누르면 이런 식으로 함수 위에 주석이 달립니다.
/**
*
* \param m
*/
void Push(cMatrix m);
/**
*
*/
void Pop();
/**
*
* \return
*/
cMatrix getMatrix();
인자값이 있을 경우 그 갯수만큼 param이 생기고 return 값이 있는 경우 return이 생깁니다.
변수 오른쪽에서는 Insert...가 불가능합니다.
코드를 문서화하는 자세한 사항은 이 링크를 통해 확인하시길 바랍니다. -> http://alones.kr/blog/722
- Build Solution Stats이 메뉴를 클릭하면 현재 솔루션의 상태에 대한 페이지가 뜹니다. 이것도 예를 보여 드리겠습니다.
Solution Statistics3D API
3D API
| Filename | code lines | commented lines | code and comments | blank lines | comment code ratio |
| ReadMe.txt | 36 | 4 | 0 | 13 | 0.11 |
| 3D API.cpp | 233 | 50 | 4 | 31 | 0.21 |
| Camera.cpp | 63 | 8 | 0 | 9 | 0.13 |
| Matrix.cpp | 80 | 0 | 0 | 26 | 0.00 |
| MatrixManager.cpp | 27 | 5 | 5 | 5 | 0.19 |
| stdafx.cpp | 1 | 5 | 0 | 2 | 5.00 |
| TransformMatrix.cpp | 115 | 22 | 0 | 23 | 0.19 |
| Triangle.cpp | 40 | 0 | 0 | 7 | 0.00 |
| Vector.cpp | 53 | 19 | 0 | 19 | 0.36 |
| 3D API.h | 4 | 0 | 0 | 2 | 0.00 |
| Camera.h | 20 | 39 | 4 | 2 | 1.95 |
| Matrix.h | 18 | 7 | 0 | 2 | 0.39 |
| MatrixManager.h | 16 | 0 | 0 | 2 | 0.00 |
| Resource.h | 20 | 6 | 0 | 3 | 0.30 |
| stdafx.h | 16 | 8 | 1 | 4 | 0.50 |
| TransformMatrix.h | 32 | 12 | 0 | 3 | 0.38 |
| Triangle.h | 11 | 1 | 1 | 1 | 0.09 |
| Vector.h | 21 | 20 | 2 | 2 | 0.95 |
| 3D API.ico | 44 | 1 | 1 | 0 | 0.02 |
| 3D API.rc | 63 | 41 | 2 | 26 | 0.65 |
| small.ico | 44 | 1 | 1 | 0 | 0.02 |
| Project Total (21 files) | 957 | 249 | 21 | 182 | 0.26 |
기타 파ì¼
| Filename | code lines | commented lines | code and comments | blank lines | comment code ratio |
Solution Total
| Files | code lines | commented lines | code and comments | blank lines | comment code ratio |
| Solution Total (21 files) | 957 | 249 | 21 | 182 | 0.26 |
이런 식으로 코드 줄 수, 주석을 단 줄 수 등등이 나오게 됩니다.
- Class Graph
이 메뉴를 클릭하면 이와 같은 창이 하나 뜹니다.
Dependency 는 종속관계가 보여지고
Inheritance 는 상속관계가 보여집니다.
체크 박스 옆에 있는 balanced or "Low Energy" graph 는
체크를 하면 클래스 같의 상속 관계도 파악이 가능한 걸로 보입니다.
직접 해보는 게 이해하기 편하므로 예는 들지 않겠습니다.
- Swap .h <-> .cpp
- Colorize
- } End of이 창은 코드 위에서 오른쪽 버튼을 누르면 나오는 팝업창에서도 뜹니다.
- configure the Doxygen
-latex
