doxygen 으로 c++ 코드를 문서화하려고 합니다. class 가 있는데, 이 클래스의 멤버에 대해 주석을 달려고 하는데, .h 에만 달면 될지, .cpp 에만 달면 될지, 아니면 둘다 달아야 될지 궁금합니다. 주로 어떻게 하나요?
원하는 방법대로 하시면 되지만, :-) 헤더 파일에 작성해 두면, 라이브러리와 헤더만 외부에 제공할 때 소스 받아 보는 입장에서는 편하겠지요. 실제 코딩할 때 doxygen으로 만든 문서를 따로 열어서 보지 않아도 되잖아요~
-= 우주인류감시위원회 =-
저와 동일한 고민을. 하시는 분이 계셨군요..
둘다 주석을 달아 놓으면 (중복으로 나타납니다.)
저는 현재 .h에 달려고 생각중입니다. (공개하면 이놈이 뭐하는지 알게 될테니까요.?)
잠이 들어야지만 꿈을 꿀수 있는것인가? 우리는 항상 꿈을 쫓아 가며 살아가는 사람들..
저는 보통 .h에 쓰고
자세한 설명이 필요한경우 소스파일에 추가적으로 자세한 설명을 써놓습니다.
----------------------- 과거를 알고 싶거든 오늘의 네 모습을 보아라. 그것이 과거의 너니라. 그리고 내일을 알고 싶으냐? 그러면 오늘의 너를 보아라. 그것이 바로 미래의 너니라.
고작 블로킹 하나, 고작 25점 중에 1점, 고작 부활동 "만약 그 순간이 온다면 그때가 네가 배구에 빠지는 순간이야"
텍스트 포맷에 대한 자세한 정보
<code>
<blockcode>
<apache>
<applescript>
<autoconf>
<awk>
<bash>
<c>
<cpp>
<css>
<diff>
<drupal5>
<drupal6>
<gdb>
<html>
<html5>
<java>
<javascript>
<ldif>
<lua>
<make>
<mysql>
<perl>
<perl6>
<php>
<pgsql>
<proftpd>
<python>
<reg>
<spec>
<ruby>
<foo>
[foo]
원하는 방법대로
원하는 방법대로 하시면 되지만, :-)
헤더 파일에 작성해 두면, 라이브러리와 헤더만 외부에 제공할 때 소스 받아 보는 입장에서는 편하겠지요.
실제 코딩할 때 doxygen으로 만든 문서를 따로 열어서 보지 않아도 되잖아요~
-= 우주인류감시위원회 =-
-= 우주인류감시위원회 =-
저와 동일한 고민을.
저와 동일한 고민을. 하시는 분이 계셨군요..
둘다 주석을 달아 놓으면 (중복으로 나타납니다.)
저는 현재 .h에 달려고 생각중입니다. (공개하면 이놈이 뭐하는지 알게 될테니까요.?)
잠이 들어야지만 꿈을 꿀수 있는것인가?
우리는 항상 꿈을 쫓아 가며 살아가는 사람들..
잠이 들어야지만 꿈을 꿀수 있는것인가?
우리는 항상 꿈을 쫓아 가며 살아가는 사람들..
저는 보통 .h에
저는 보통 .h에 쓰고
자세한 설명이 필요한경우 소스파일에 추가적으로 자세한 설명을 써놓습니다.
-----------------------
과거를 알고 싶거든 오늘의 네 모습을 보아라. 그것이 과거의 너니라.
그리고 내일을 알고 싶으냐?
그러면 오늘의 너를 보아라. 그것이 바로 미래의 너니라.
고작 블로킹 하나, 고작 25점 중에 1점, 고작 부활동
"만약 그 순간이 온다면 그때가 네가 배구에 빠지는 순간이야"
댓글 달기