폴더 수준 문서를 C# 어셈블리에 어떻게 추가합니까?

Question

나 : 나는 .NET 플랫폼의 비교적 새로운 코너 다.

문제

자바에서, 당신은 package-info.java 나에 package.html 파일을 생성하고 패키지 폴더에 저장하여 프로젝트에 패키지 레벨 문서를 추가 할 수 있습니다. Visual Studio 2010을 사용하여 C#에서 프로젝트에 동일한 설명서를 추가하려면 어떻게합니까?

배경 내가 일하고 소스 코드 프로젝트의 패키지/폴더 수준의 맥락에서 내 동기를 설명하는 문서를 작성하고자

. 나는이 워크 플로에 다양한 언어 (특히 Java)로 익숙해졌으며 프로젝트를 문서화하는 좋은 방법이라고 생각합니다.

Answer 1

포커스가 .NET에서 약간 다르지만 IntelliSense 정보를 생성하는 데 매우 적합합니다. 손가락 끝의 문서. 나는 당신이 VS를 잠시 사용했을 때 익숙하다고 확신하며, "XML 문서"를 찾는다.

오프라인 문서는 NDoc에서 다루었지만 그 문서를 지원 한 사람은 프로젝트를 종료했습니다. Sandcastle project이 느슨해졌습니다. 요즘 너무 조금 뒤떨어져 보입니다.

Answer 2

C#은 자동으로 XML 기반 삼중 슬래시 설명을 인텔리 센스 문서로 변환합니다.

///<summary>This method does something!</summary> 
///<parameter name="p1">The first parameter</parameter> 
///<return>true, if the method completed successfully</return> 
public bool DoSomething(int p1){ 
    return p1 > 0; 
} 

프로젝트를 클래스 라이브러리로 컴파일하고 다른 프로젝트에서 참조하면 위의 코드는 유용한 툴팁으로 자동 변환됩니다. 또한 C# 컴파일러는 DLL과 함께 이러한 주석이 모두 포함 된 XML 파일을 선택적으로 생성 할 수 있습니다. 이 XML 파일은 Sandcastle (이전에 언급 한대로)에 입력하여 MSDN 스타일 API 참조 문서 프로젝트에 추가 할 수 있습니다.

Sandcastle 도구에는 자체 프로젝트 및 문서 구조가 있으므로 XML로 생성 된 Intellisense 참조 이외의 것을 추가하려는 경우 사이드 프로젝트를 시작해야합니다.