본문 바로가기

독에프엑스

DocFX

닷넷 API 문서 생성기

한줄평

.NET 라이브러리를 만들면서 코드 주석을 그대로 문서로 연결하고 싶은 팀에 잘 맞습니다. 다만 .NET 생태계에 특화돼 있어 다른 언어 프로젝트에는 실익이 적습니다.

이런 분께 C#·.NET 라이브러리의 API 문서를 자동으로 만들고 싶은 개발자께

좋은 점

  • 코드 주석에서 API 문서를 자동 생성
  • Markdown 가이드와 한 사이트로 발행

아쉬운 점

  • 사실상 .NET 전용이라 범용성이 낮음
  • 설정 파일과 템플릿 학습이 필요함

독에프엑스 소개

소스 코드의 주석과 Markdown 파일을 읽어 정적 문서 사이트를 만들어 주는 명령줄 도구입니다. 주로 C#·.NET 프로젝트의 API 레퍼런스를 자동으로 뽑아내고, 별도의 가이드 문서와 합쳐 하나의 웹사이트로 발행할 때 씁니다. 마이크로소프트가 오픈소스로 관리하며, 빌드 산출물은 그대로 GitHub Pages 등에 올릴 수 있습니다. GUI 없이 프로젝트 설정(docfx.json)과 명령으로 동작합니다.

제작사

영삼넷 · 공식 홈페이지

독에프엑스 (DocFX) 무료 다운로드 | 자료실 | 영삼넷