2010-06-29 2 views
3

내가 개발 한 기능에 설명을 추가하려고합니다. 다른 개발자가 내 장치를 사용하거나 사용자가 API/COM을 사용하여 소프트웨어를 연결하고 사용할 때이 설명을 코드 통찰력에 표시하고 싶습니다. . 현재 볼 수있는 것은 모두 예를 들어 함수 이름과 반환 형식이지만 함수가 정확히 무엇인지는 알지 못합니다.Code Insight (IntelliSense)

C#에서는 XML 태그를 사용합니다.

답변

1

내가 그 당신이 필요로하는 무엇 모르겠지만 :

/// <summary> 
    /// 
    /// </summary> 
    /// <param name="par1"></param> 
    /// <param name="bla"></param> 
    /// <param name="foo"></param> 
    /// <returns></returns> 

함수 선언 위에이 넣어 당신이이 요약 를 (단지/문자를 세 번 입력하고 비주얼 스튜디오 마법을 할 것입니다) 설명을 넣으십시오.

+0

추가 보너스로, GExperts가 설치되어 있으면 함수 선언 위에 "xdoc"과 Alt + Maj + T를 입력하면 모든 태그가 자동으로 추가됩니다. – LeGEC

3

Visual Studio에서 HelpInsight를 사용자 정의하는 데 사용하는 XML 태그와 동일한 시스템을 사용하는 방법에 대해서는 Marco Cantu가 a great blog post 있습니다.

+1

+1. 불행하게도이 코드는 실제 코드가 아닌 사소한 (읽기 : 테스트) 케이스에서만 작동합니다. –

+0

Cosmin - 문제를 확대 할 수 있습니까? "실제 코드"에서 제대로 작동해야합니다. –

+2

@ 닉 (Nick) : 문제는 * 통찰력이 일반적으로 심하게 짖는 것이고 중요하지 않은 코드베이스에서 매우 빠르게 저하된다는 것입니다. –