저는 기존 응용 프로그램에서 작업하고 있습니다. 실제로 C# .NET에서 처음부터 다시 작성하고 있습니다. 그리고 WinHelp를 사용하여 사용자에게 어떤 도움을주기 위해 사용되었지만 Vista (시스템을 개발 중입니다)는 WinHelp를 지원하지 않는다고 말합니다. 그래서 내가 묻는 것은 :내 응용 프로그램에 대한 도움말 파일을 만듭니다.
C# .NET과 비슷한 시스템을 만들려면 어떻게해야합니까? 나는 새로운 기능을 Vista, XP 및 이전 Windows 버전에서 사용하기를 원합니다.
사용되지 않는 WinHelp 파일 대신 CHM 파일을 사용하십시오. HTML Help Workshop을 사용하여 해당 파일을 만들 수 있습니다.
요즘은 Microsoft Sandcastle 문서 생성기를 사용하고 싶습니다. HTML 도움말 v1.0/1.1 파일 (CHM) 또는 v2.0 (Visual Studio 도움말에 통합)을 완벽하게 생성 할 수 있습니다. 실제 .NET Framework 개발 팀은이 API를 사용하여 BCL에 대한 API 설명서를 만들었으므로 BCL에 대한 API 설명서를 만들 수 있습니다. 당연히 의도 한 문서의 성격에 대해서는 확신 할 수 없지만 Sandcastle은 API 설명서과 관련 도움말 페이지 (가이드, 자습서, 예제, 백서, 용어집 등)를 생성하는 데 모두 사용할 수 있습니다. 사용자 정의 MAML (XML과 같은) 마크 업 언어는 본질적으로 코드에서 XML 주석에 사용됩니다.
Here은 Sandcastle을 시작하는 데있어 기본 지침이지만, 조금만 이해하면됩니다. 커맨드 라인에서 배우는 것이 아니라면, 학습 곡선이 특별히 가파른 것은 아닙니다. 가장 쉬운 옵션은 Sandcastle Help File Builder GUI을 사용하는 것입니다.이 도구는 훌륭한 도구이며 전혀 제한하지 않습니다.
또 다른 유용한 리소스는 this C# XML Documentation guide이며 CHM 설명서 및 IntelliSense로 변환 될 수있는 XML 주석을 사용하여 API를 올바르게 문서화하는 방법을 보여줍니다.
Sandcastle은 API 도움말을 생성하는 데 적합합니다. 그러나 응용 프로그램 내에서 상황에 맞는 도움말은 그리 많지 않습니다. –
@Mehrdad : 실제로 API와 사용자 지정 텍스트 문서 모두에서 잘 작동합니다. 나는 그것을 나의 경험에서 공정한 양으로 사용했고, 그것을하는 것이 쉬운 것을 알았다. – Noldorin
@ Noldorin : 나는 그것이 강력한 도구라는 것에 동의하지만 때때로 너무 많은 불필요한 힘을 제공합니다. 특히 응용 프로그램 설명서가 본질적으로 함께 바인딩하려는 원시 HTML 파일 집합 인 경우가 있습니다. 나는 명령 행 hh.exe를 선호한다. –
CHM은 훌륭합니다. 저는 최근에야 당신이 7zip으로 열 수 있음을 깨달았습니다. CHM은 쉽고, 휴대가 가능하며 언제든지 곧 중단 될 수 없습니다. – Copas
제안에 감사드립니다, Mehrdad. 맞습니다. CHM을 사용하는 것이 좋습니다. – Attilah