함수 문서를 intellisense에 표시 할 위치는 어디입니까?

Question

필자는 라이브러리를 작성 중이며 필자는 내장 함수에 대한 인텔리 센스가 각 매개 변수와 함수 자체에 대한 설명을 표시하는 것과 같은 종류의 인텔리 센스로 표시되도록 필자의 기능에 문서를 넣고 싶습니다. 어떻게 문서를 넣을 수 있습니까? 함수의 주석을 통해 또는 일부 별도의 파일에 있습니까?

Answer 1

함수 서명 위의 XML 주석을 사용하십시오.

/// <summary> 
    /// Summary 
    /// </summary> 
    /// <param name="param1">Some Parameter.</param> 
    /// <returns>What this method returns.</returns> 

GhostDoc 플러그인은 당신을 위해 다음을 생성 할 수 있습니다.

Answer 2

XML 주석뿐만 아니라 (프로젝트 설정에서) 문서 작성을 가능하게하고 생성 된 XML 파일을 어셈블리와 함께 유지해야합니다.

Answer 3

"XML 문서 주석 (C# 프로그래밍 가이드) 그들에 소스 코드에 특별한 코멘트 필드에 XML 태그를 포함하여 코드에 대한 문서를 만들 수 있습니다 비주얼 C#에서 을 참조 직접 코드 블록 전에."

http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

당신이 당신의 정보는 다음의 제품에

http://www.hanselman.com/blog/SandcastleMicrosoftCTPOfAHelpCHMFileGeneratorOnTheTailsOfTheDeathOfNDoc.aspx

Answer 4

기존 방법의 상단에있는 세 개의 슬래시 코멘트 섹션을 자동으로 생성하려면 너무 경우 CHM 파일을 생성하는 샌드캐슬을 사용할 수 있습니다, 메서드 정의 바로 위에 빈 줄에 커서를 놓고 세 개의 슬래시 ("///")를 입력하면됩니다. Visual Studio는 메서드에 해당하는 세 줄의 주석을 자동으로 생성합니다. 요약, 각 매개 변수 (있는 경우) 및 반환 값 (있는 경우)에 대한 자리 표시자를 갖습니다. 공란을 채워 넣기 만하면됩니다.

이 설명 블록을 수동으로 작성하지 말고 한 방법에서 다른 방법으로 복사하지 않는 것이 좋습니다. 타사 도구도 생성 할 필요가 없습니다 (적어도 Visual Studio 2010에서는).