C#/VisualStudio 2008에서 코드 문서를 어떻게 내보내나요?

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

문제

저는 항상 C# xml 구문을 사용하여 클래스와 메서드에 대한 멋진 코드 주석을 작성하는 데 중점을 두었습니다.나는 항상 나중에 쉽게 내보낼 수 있을 것이라고 기대했습니다.

오늘은 실제로 그렇게 해야 하는데 방법을 찾는 데 어려움을 겪고 있습니다.내가 놓친 것이 있나요?나는 가고 싶다 메뉴->빌드->코드 문서 빌드, 하지만 그렇게 할 수 있는 옵션은 없습니다.

도움이 되었습니까?

해결책

실제로 그것은 프로젝트 속성에 있습니다.빌드 탭, 출력 섹션, XML 문서 파일을 클릭하고 파일 이름을 입력합니다.이는 프로젝트의 모든 빌드에 구축됩니다.

그 후에는 다음을 사용하여 실제 도움말을 작성할 수 있습니다. 모래성.

다른 팁

당신은 시도해 볼 수 있습니다 NDOC 또는 모래성 타사 도구를 사용해도 괜찮다면.

모래성 문서 생성에 꽤 잘 작동하며 생성을 위해 몇 가지 다른 형식을 지원합니다.내가 아는 한 Visual Studio 통합은 없지만 샌드캐슬GUI 그것을 위해 사용할 수 있습니다.

LINQ to SQL을 사용하는 경우 자동 생성된 개체에 지속 가능한 주석을 쉽게 추가할 수 없으므로 주의하세요.

늦은 댓글이지만 Sandcastle이 좀처럼 사용되지 않음에도 불구하고 추가할 가치가 있습니다. Sandcastle 도움말 파일 빌더 여전히 활발한 개발이 진행 중이며, 이 상황을 처리할 때 매우 강력하고 간단하다는 것을 알았습니다. 몇 시간 안에 풍부한 .chm 및 .html/.asp 출력을 설치하는 것입니다.

(다른 사람들이 언급한) 원래 NDoc 프로젝트는 종료되었지만 다음과 같은 새로운 프로젝트가 있습니다. NDoc3.

NDoc3은 .NET 2.0 - 3.5를 지원합니다.현재 베타 버전으로 제공되고 있으며 저에게 매우 효과적이었습니다.프로젝트가 아직 활성화되어 있는지 확실하지 않습니다. 마지막 베타 버전은 2009년 4월에 출시되었습니다.

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