Sandcastle Help File Builder and Tools (Install)

프로그램 소개

Sandcastle Help File Builder는 관리형 클래스 라이브러리를 위한 도움말 파일 빌드 도구입니다. 소스 코드의 XML 주석을 자동으로 분석하고, .NET Framework 어셈블리의 구문 및 구조를 반영하여 개념 주제와 API 레퍼런스 주제를 포함하는 완전한 도움말 파일을 생성합니다.

주요 기능

• XML 주석 기반 API 문서 생성: 소스 코드에 포함된 XML 주석을 분석하여 API 레퍼런스 주제를 자동으로 만듭니다.
• 개념 주제 지원: Markdown 또는 Microsoft Assistance Markup Language(MAML)로 작성된 파일을 개념 주제로 변환합니다.
• GUI 및 명령줄 인터페이스: 독립형 GUI와 명령줄 기반 도구를 모두 제공하여 자동화된 빌드 프로세스를 지원합니다.
• Visual Studio 통합: Visual Studio 확장 패키지를 통해 도움말 프로젝트를 Visual Studio 내에서 직접 생성하고 관리할 수 있습니다.

다운로드·설치 방법

최신 버전은 프로젝트의 GitHub 릴리스 페이지에서 다운로드할 수 있습니다. ‘SandcastleInstaller.exe’를 실행하면 guided installation이 시작되어, 필요한 도구와 설정 과정을 안내합니다. 이 과정에서 Sandcastle 도구와 추가 구성 요소가 자동으로 설치됩니다.

Visual Studio 통합을 원하는 경우, 설치 과정에서 SHFB Visual Studio Extension Package를 함께 설치할 수 있습니다. 이 패키지는 VS 2022 이상을 지원합니다.

기본 사용법

설치 후 시작 메뉴의 ‘Sandcastle Help File Builder’ 폴더에서 프로그램을 실행할 수 있습니다. 도움말 파일 빌드 프로젝트를 생성하고, XML 주석이 포함된 소스 코드를 지정하면 API 문서를 자동으로 생성합니다. 명령줄 도구를 사용하여 빌드 프로세스를 스크립트로 자동화할 수도 있습니다.

지원 환경·시스템 요구사항

이 도구는 Windows에서 실행됩니다. 추가 도구가 필요하며, 설치 과정에서 필요한 구성 요소와 설정 방법을 안내합니다. .NET Framework를 사용하는 관리형 코드 프로젝트의 문서화에 적합합니다.

제한 사항·확인 사항

Sandcastle 도구는 Microsoft가 2012년에 공식적으로 지원과 개발을 중단했습니다. 현재 Sandcastle Help File Builder 프로젝트에서 통합되어 개발 및 지원이 계속됩니다. 도움말 파일을 생성하려면 해당 소스 코드에 XML 주석이 포함되어 있어야 합니다.