문서화(Documentation)

D 언어는 현대 소프트웨어 공학에서 쓰이는 여러 필수 요소를 언어 내부에 통합하려는 여러 시도를 하고 있습니다.

계약에 의한 프로그래밍(contract programming) 이나 유닛 테스트(unittesting) 요소도 있지만, D 언어는 컴파일러가 소스 코드내에 작성된 코멘트를 문서로 바꿔주는 문서화 요소까지 지원하고 있습니다.

물론 모든 코멘트가 문서화되는 건 아니며, 규정된 형식을 지켜 작성해주면 dmd -D 명령어 한번에 소스코드로부터 웹에 게시 가능한 HTML을 생성해줍니다. 가장 가까운 적용 사례는 Phobos 표준 라이브러리 문서 입니다. 이 문서는 DDoc 을 사용해 만들어졌습니다.

아래의 코멘트 스타일로 작성하면 DDoc 이 일반 코멘트가 아닌 문서화 요소로 파악하게 됩니다.

• /// struct, class, function 전에 선언합니다
• /++ 특수문자 + 2개로 시작하는 코멘트입니다 +/
• /** 특수문자 * 2개로 시작하는 코멘트입니다 */

아래 예제에서 문서화를 진행할 때 지키면 좋을 모범사례를 살펴볼 수 있습니다.

더 살펴보기

• DDoc design
• Phobos standard library documentation

rdmd playground.d