[sandCastle] C#의 xml 주석에서 도움말 파일 만들기(.chm)

8497 단어 SandcastledllchmC#
제비를 뽑다
https://qiita.com/tera1707/items/4fda73d86eded283ec4f

하고 싶은 일

SandcastleHelpFileBuilder로 매뉴얼(도움말문건)을 만드는 프로그램 라이브러리가 있는데, 이 매뉴얼이 만들어진 환경을 만들었기 때문에 당시 노트를 남겼다.
다음은 DLL에서 사용할 수 있는 API의 일람과 설명이 포함된 이미지(.chm 파일)입니다.

절차.


SandcastleHelpFileBuilder 다운로드


아래에서 다운로드하십시오.
https://github.com/EWSoftware/SHFB/releases
이번에 사용v2020.3.6.0(Visual Studio 2019에서도 사용 가능)

zip 다운로드

설치하다.


SandcastleInstaller.두드리기 설치exe

Sandcastle Help File Builder and Tools가 표시될 때까지 Next 키를 누릅니다.

Install SHFB 키를 누릅니다.

마법사에 표시된 대로 Next 기준

SHFB 설치 완료

여기 설치된 것 같은데.NEXT 키를 누릅니다.

VS 2017, 2019에서 사용 가능한 포장에 넣습니다.
InstallPackage 를 누르고 마법사별로 설치

Vsix Installer가 나오기 때문에 그가 말한 대로 설치합니다.
끝나면 Next.

현재 댓글은 모두 손으로 쓴 것으로 이 기능은 사용하지 않는 것 같아서 설치가 아닌 넥스트다.

이것도 마찬가지야.

다음 단계.

다음 단계.

설치 작업이 완료되었습니다.PC를 재부팅합니다.

VS에서의 작업


문서를 만들 C#의 DLL 항목 속성 열기
[빌드] [출력] 막대의 [XML 문서 파일]을 선택합니다.
(기본 경로 OK)

그리고 문서를 구축할 때 출력 대상 폴더에 xml을 생성합니다.

Visual Studio의 솔루션 리소스 매니저를 마우스 오른쪽 버튼으로 클릭하고 새 항목 추가를 선택합니다.
항목 유형에서 Doctorumentation을 선택하고 Sand Castle HelpFile Buidler를 선택하여 결정합니다.

Docoment 항목 만들기

Documentation Sources 를 마우스 오른쪽 버튼으로 클릭하고 Add Doocumentation Source 를 선택합니다.

문서를 만들 C#의 DLL 출력 dll을 선택합니다.

그리고 프로젝트의 설정을 마음대로 바꾸는 것이다.
(이하 개인의 취향에 따라 변경됨)
문서의chem 파일의 출력 주소를 좋아하는 곳으로 변경합니다.
(문서 엔지니어링 위치 기준, 상대 경로 OK)

기본적으로 C++ 등도 체크되지만 C#만 가능하므로 C#만 체크합니다.
이번에 원하는 것은 .chm의 도움말 파일만 있기 때문에 HTML Help1(chm)에서 선택하십시오.
Help File namechem 파일의 이름에 Help title이 도움말 창의 제목이 됩니다.

창 제목


보호자의 구성원이든 뭐든 필요 없는 사람은 제외시켜라.

도움말 파일을 연 후 처음 표시되는 Welcome 페이지에 대한 설명이 있는 파일 Welcome.aml이 허브 폴더에 있습니다.
그 WelCome 페이지의 내용은 아래의 Content Layout입니다.콘텐츠 파일을 만지작거리면 다양하게 바뀔 수 있지만 이번엔 그런 거 안 하고 DLL 규격을chm로 하면 되니까 지우는 게 좋을 것 같아요.

최종적으로 다음과 같이 구성에 대해 간헐적인 인용을 진행하였다.

출력 파일은 다음과 같습니다.

이런 느낌으로 출력했어요.

댓글을 제대로 못 써서 오류를 보였는데 잘 쓰면 잘 나올 것 같아요.

인용하다


Sandcastle(XML 주석을 통한 API 도움말 생성)
여기 쓴 내용을 대체로 참고하였다.감사합니다.
https://blog.nextscape.net/research/dotnetenv/sandcastle
사구고양이github
https://github.com/EWSoftware/SHFB
모래 언덕 고양이의 Release 버전 다운로드 페이지
https://github.com/EWSoftware/SHFB/releases

좋은 웹페이지 즐겨찾기