함수 호출 계층 구조 문서화

광범위한 래퍼 라이브러리를 개발 중입니다. 래퍼는 기본 함수에 1 대 1을 매핑하지 않으므로 함수 호출 계층 구조를 문서화하는 것이 좋습니다.함수 호출 계층 구조 문서화

이 작업을 수행하는 가장 좋은 방법은 무엇입니까? 이상적으로는 XML 주석에 통합 될 수 있으며 읽을 수있는/검색 가능한 문서를 생성하는 데 사용됩니다. 그러나 실제적인 해결책은 환영합니다.

출처

2012-05-08 Eugene Cheipesh

Doxygen can generate callgraphs. enter image description here

출처

2012-05-08 19:12:38

이것은 가장 도움이되는 것으로 밝혀졌습니다. –

샌드캐슬 개념 주제는 XML 주석의 예에 포함 될 수있는 블록 요소가 있습니다. 표, 목록. 이러한 요소를 사용하여 흐름 시퀀스를 열거해야합니다.

또는 VS2010의 아키텍처 도구 나 NDepend와 같은 다른 도구를 사용하여 호출 그래프, 시퀀스 다이어그램을 생성하고 HTML 태그를 사용하여 이러한 이미지를 문서에 포함 할 수 있습니다.

출처

2012-05-09 18:44:53 ideafountain

첫 번째 제안은 내가 찾고있는 것처럼 들립니다. 너에게 약간의 포인터를 줄 수 있니? 주제를 찾는 데 문제가 있습니다. –

찾았습니다. http://www.codeproject.com/Articles/22539/Sandcastle-Conceptual-Help-Quick-Start – ideafountain

코드에 주석을 추가하려면 사용자 정의 태그 추가에 대한 링크를 시도하십시오. http : // blogs.msdn.com/b/sandcastle/archive/2006/11/22/supporting-custom-tags-in-sandcastle.aspx – ideafountain

함수 호출 계층 구조 문서화

답변

관련 문제