위키득계정 ↗
기술

Clang-Doc

Clang-Doc기술
실행 이름
clang-doc
기반
LibTooling
입력
소스 코드와 주석
출력 형식 예
HTML Markdown YAML
Clang-Doc는 C와 C플러스플러스 소스 및 주석으로부터 문서를 생성하는 도구다. 프로젝트의 선언 구조를 분석해 네임스페이스와 자료형 등에 대한 설명을 출력한다.

코드와 설명 연결

함수와 메서드, 열거형 등의 선언 정보와 주석을 연결해 문서를 구성한다. 소스에 존재하는 인터페이스와 설명을 함께 관리하는 데 활용할 수 있다. 주석이 실제 동작을 정확하게 설명하는지는 작성자가 따로 검토해야 한다.

프로젝트 처리

LibTooling 기반이므로 프로젝트를 해석하는 컴파일 명령 데이터베이스가 필요하다. 개별 파일이나 데이터베이스의 파일 집합을 처리하고 일부 파일만 걸러 선택할 수도 있다. 빌드 조건이 맞지 않으면 선언을 정확하게 추출하기 어렵다.

출력과 성숙도

출력 디렉터리와 문서 형식을 지정할 수 있으며 HTML용 추가 설정도 제공한다. 공식 문서는 개발 초기 단계임을 안내하므로 사용하는 버전에서 생성 결과를 확인해야 한다. 자동 생성은 문서 구조를 돕지만 누락된 사용법과 설명을 대신 작성해 주지는 않는다.

관련 문서

Clang / ClangCheck / Compiledb / Clang-Tidy