728x90
반응형
서론
소스를 바로 문서화하는데 doxygen을 많이 이용하는데, 메소드에 대한 주석을 적는 것이 상당한 노력이 필요합니다. doxygen 문법에 맞게 일일이 적어 주기가 부지런하지 않으면 쉽지 않은 일입니다.그러나 정해진 형식대로만 적으면 되기 때문에, VisualAssistX를 이용한다면, 매우 편리하게 메소드에 대하여 doxygen 문법에 맞게 주석을 손쉽게 작성할 수 있습니다. VisualAssistX의 Refactor Document Method와 VA Snipppet을 이용하면, 메소드에 대한 설명과 매개변수에 대한 설명만을 적어주면 doxygen 문법대로 바로 주석 입력이 가능합니다.
Refactor Document Method를 이용하기 위해서는 먼저 아래 그림과 같이 VisualAssistX에서 VA Snipppet에 Refactor Document Method에 대한 Snippet을 작성해야 합니다.
위 그림과 같이 VisualAssistX의 "Tools" 메뉴에서 "Edit VA Snippets..." 메뉴를 선택하여 VA Snippet을 편집할 수 있는 창을 띄웁니다. 그럼 아래과 같이 "Refactor Document Method"를 선택하면 기본적으로 입력되어 있는 메소드 주석 서식이 있습니다.
기본적으로 입력되어 있는 메소드 주석 서식을 아래와 같이 doxygen 메소드 주석 서식에 맞도록 수정해 줍니다.
위 상태까지 입력을 했다면, 코드 에디터에서 메소드 이름에 마우스 커서를 위치시킨 후에 오른쪽 마우스 버튼을 눌러서 나오는 팝업 메뉴의 "Refactor (VA X)"의 "Refactor Document Method"를 선택하여 사용할 수도 있지만, VisualAssistX "Refactor Rename"와 같이 단축키를 지정하야 사용하면 더욱 편리하게 이용할 수 있습니다.
"Refactor Document Method"에 대한 단축키는 VisualStudio의 "Tools > Options" 메뉴를 선택하면 아래와 같은 옵션 설정창이 나타납니다. 이 창에서 아래와 같이 Refactor Document Method" 메뉴에 대한 단축키를 지정해 놓으면 코드를 편집하며 doxygen 문법에 맞도록 순쉽게 주석의 입력이 가능해 집니다.
참고자료
'프로그래밍' 카테고리의 다른 글
| 배치 파일에서 날짜 관련 문자열(yyyymmdd) 만들기 (4) | 2012.04.17 |
|---|---|
| 7zip과 배치 파일을 이용한 간편한 소스 백업 방법 (2) | 2012.04.10 |
| C++/CLI 참고자료(Reference) (0) | 2011.07.04 |
| Visual C++ 개발에 도움을 주는 유틸리티들 (0) | 2011.07.01 |
| Google breakpad - An open-source multi-platform crash reporting system (0) | 2011.06.01 |