C# 코드를 어떻게 문서화해야합니까? [닫은

StackOverflow https://stackoverflow.com/questions/710257

문제

C# API가 포함 된 문서를 작성하고 있습니다.

  1. DOC/PDF 파일로서 현재 상태에 대한 일반적인 개요 및 설명.
  2. Sandcastle을 사용하는 .chm 파일의 클래스 라이브러리 API.

질문:

  1. 이 두 가지를 동일한 .chm 파일로 병합해야합니까? 그들을 합병하는 좋은 방법은 무엇입니까?
  2. 특정 클래스/패키지를 제외해야합니다. Sandcastle에서 어떻게 지정할 수 있습니까?
  3. VB 코드와 Visual C ++ 코드에 대한 문서를 생성합니다. 이것을 어떻게 변경할 수 있습니까? 아니면 안전 코드 만 사용하고 있다는 것을 알고 남겨 두어야합니까?
  4. 내 시스템에서 HTML 도움말 2.X 뷰어 경로는 어디에서 찾을 수 있습니까?

편집하다:

위에서 제가 작성하는 주석, 필드 및 클래스는 문서에서 생성되지 않습니다.

어떻게해야합니까?

도움이 되었습니까?

해결책

나는 당신이 사용하는 것이 좋습니다 Sandcastle 도움말 파일 빌더 CodePlex에서. 네임 스페이스를 쉽게 포함시키고 제외 할 수 있지만 단일 클래스를 제외하는 방법은 확실하지 않습니다. 공개/보호 클래스에 대한 문서 만 생성하는 옵션을 설정할 수 있지만 시나리오에 맞는지 모르겠습니다.

두 번째 질문에 대해 SHFB의 특정 언어를 대상으로 할 수도 있습니다.

또한 Doc/PDF 파일에있는 것으로 언급하는 것과 같은 개념 문서를 위해 SHFB 내에서 MAML을 사용할 수 있습니다. 당신은 사용할 수 있어야합니다 doc2maml 기존 문서를 마이그레이션합니다. doc2maml은 docproject의 일부이지만 독립형 실행을 실행할 수있는 것으로 보입니다.

의견에 대한 응답으로 편집 :

지시 사항은 SHFB 1.8.0.1 용입니다. 1.7에서 정확한 방법을 기억하지는 않지만 비슷하다고 생각합니다.

  1. 프로젝트 속성 탭의 "댓글"그룹 아래에서 "네임 스페이스 미 마리"오른쪽의 엘리시 시스를 클릭하십시오.
  2. 왼쪽 상단의 확인란 목록에서 제외하려는 네임 스페이스를 선택 취소하십시오.

이것은 또한 네임 스페이스 요약을 넣는 화면이기도합니다.

다른 팁

위에서 언급했듯이 Sand Castle 외에도 보는 것이 좋습니다. fxcop 그리고 스타일 콥 코드와 문서가 CLS 규정 준수 표준에 달려 있는지 확인하십시오.

Sandcastle 도움말 파일 빌더 (SHFB) 자체는 .CHM 파일이있어 "생성 된 문서에서 특정 네임 스페이스 나 클래스를 어떻게 제외 할 수 있습니까?"와 같은 질문에 대한 답변을 찾을 수 있습니다.

당신은 내가 대답을 알고 있다고 생각할 수도 있고 당신에게 말하지 않아서 나는 멍청하고 있습니다. 사실이 아니다. 그러나 나는 어제 밤에 문서를 훑어 보고이 주제에 대한 항목을 보았다.

왜 VB와 C ++ 물건에 떠나지 않을지 모르겠습니다. 미래에 (놀랍게도) 언어를 사용하는 사람이있을 수 있습니다. C# 아님 도서관과 함께. 언어는 일반적으로 도움말 뷰어가 해결할 수 있으므로 C# Devs는 VB 구문을 무시할 수 있습니다.

병합의 경우 SHFB는 임의의 계층 구조에서 임의의 HTML을 추가하는 메커니즘을 가지고 있습니다. GUI에서는 여기에 있습니다.

http://www.freeimagehosting.net/uploads/7de19ea568.jpg

이것을 사용하면 pdf/doc을 HTML로 변환 한 다음 .CHM에 포함시킬 수 있습니다.

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top