2012-03-12 3 views
2

Boost.Test 매크로를 사용하여 정의 된 테스트 케이스에 대한 다큐멘터리 주석을 사용하는 방법은 없나요? Doxygen 스타일의 주석을 사용할 수 있습니까? 정확하게 파싱됩니까?문서화 Boost.Test 테스트 케이스

+1

하여 doxygen이 [전처리 문서]에 따르면 (http://www.stack.nl/~dimitri/doxygen/preprocessing.html를) 정상 doxygen이 스타일의 의견이 시험을 문서화 할 수 있어야하지만, 당신은 아마 것 구성 파일에'predefined' 플래그로 놀기 위해 약간의 시간을 소비해야합니다. 'this '(http://www.stack.nl/~dimitri/doxygen/preprocessing.html) 페이지의 중간에있는'IUnknown' 클래스 예제를보십시오. – Chris

답변

1

대답은 테스트 케이스가 너무 간단 너무 명백하고 당신이 쓰는 모든 문서는 불필요 너무 쉽게 읽을 수 있도록하는 것입니다. 내 rewrite of the Boost.Test docsTest Case Maintenance and Design 섹션을 참조하십시오.

+0

그래, 잘 모르겠지만, 테스트 할 클래스에 첨부 된 모든 테스트 케이스 목록을 가지고 있으면 좋을 것이라고 생각한다. – Rene

+0

이것은 정당화 된 IMO가 아닌 추가적인 유지 관리 부담을 추가합니다. 실제 주석이 코드와 다른 경우는 이미 있습니다. 소프트웨어 엔지니어링의 추세는 의견이나 추가 메타 데이터에 의존하지 않고 [코드로 직접 아이디어를 표현] (https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md#Rp-direct)되었습니다. 암호. – legalize