3

비주얼 스튜디오 문서 XML 주석 태그의 신비 "사용"태그 :나는 종종 내 클래스, 메소드 및 속성을 기록하지만 Microsoft에서 제공하는이 방법에서 살펴 봐야 XML 문서를 사용

enter image description here

사용? 어떤 종류의 마법이야? 어떻게이 마법을 에뮬레이션하나요?

소스 코드에는 아무 것도 없습니다. (닷넷 4.5). xmldoc 태그도 없으며, 존재하지도 않고 툴팁에 나타납니다.

나는 그 동안 잠시 알아 차렸지만 조사 할 시간이 없었다. 그래서 나는 적어도 한 시간을 낭비없이 찾아 내려고했다.

툴팁으로 표시되기 때문에 좋은 것입니다. 우리는 <example> 태그를 가지고 있지만, 그렇지 않습니다. 이것은 완전히 다른 짐승입니다.

답변

4

내가 찾을 수있는 것은 <code> 요소이지만 이미지 에서처럼 깔끔한 출력을 제공하지 못합니다. 같은 XML 주석을 포함하지 않는 reference codegithub, 나는 그런 Usage 것으로, 다른 방법도 async 사람을 찾을 수 없습니다 : 어딘가에 비주얼 스튜디오 내부 Task 정적 메소드에 하드 코딩처럼

는 것 같습니다.

아마도 Visual Studio에서 async/await 구문을 지원하기 때문에 개발자가 생성 된 작업을 기다리는 것을 잊지 않도록 알릴 수 있습니다.

업데이트 : 저는 이것이 Visual Studio 동작이라고 생각합니다. 이러한 코드를 생각해

public static Task<int> TestMethod1() 
{ 
    return Task.FromResult(9); 
} 

public static async Task<int> TestMethod2() 
{ 
    return await Task.FromResult(9); 
} 

Usage for TestMethod1

Usage for TestMethod2

어떤 XML 주석없이 팝업에서 Usage 섹션을 얻을 것이다 이러한 방법, 모두. 따라서 개발자가 Task을 기다리는 것을 잊지 않도록 상기시켜줍니다.