Ddoc

Ddoc

DdocWalter Bright가 설계한 D 프로그래밍 언어용 컴파일러 내장 문서 생성기 및 관련 구문입니다.코드 코멘트에 자연스러운 스타일로 문서를 작성할 수 있어 삽입 마크업의 필요성을 최소화하고 코드 코멘트의 가독성을 향상시키는 것이 주안점입니다.DoxygenJavadoc과 비슷한 개념입니다.

코드 코멘트는 코드 내의 기호와 관련지어지며 Ddoc은 D 컴파일러에서 사용할 수 있는 의미 및 구문 정보를 사용하여 파라미터 및 반환 유형 등의 루틴 정보를 자동으로 입력합니다.

코드 주석 및 기호 테이블 정보는 Ddoc에 의해 내부 구조화된 형식으로 처리됩니다.이러한 구조는 각각 매크로로 표현되는 템플릿에 대응합니다.템플릿 매크로는 구조화된 형식을 마크업을 나타내는 다른 매크로 세트로 변환합니다.후자의 마크업 매크로 세트는 기본적으로 HTML을 생성하도록 확장됩니다.

템플릿 매크로와 마크업 매크로 모두 사용자가 덮어쓸 수 있으며 HTML 스타일 시트와 유사한 외부 파일을 통해 적용할 수 있습니다.템플릿 매크로는 고급 포맷을 커스터마이즈하도록 변경할 수 있으며 마크업 매크로는 XML이나 XHTML 등의 다른 출력 형식을 생성하도록 변경할 수 있습니다.

컴파일러 옵션

dmd D 컴파일러가 HTML 문서 파일을 출력하도록 하려면 다음과 같은 컴파일러 옵션을 사용할 수 있습니다.

  • /-Dgenerate documentation - 출력은 D 소스 파일과 이름이 같고 확장자는 ".d"가 ".html"로 바뀝니다.
  • /-Dd<directory>문서 파일을 디렉토리에 쓰고 출력 파일 이름은 -D 옵션과 동일합니다.
  • /-Df<filename>파일명에 문서 파일을 씁니다(.document 확장자는 자동으로 추가되지 않습니다).

외부 링크