2009-12-04 4 views
32

저는 현재 프로그래밍 학생이며 분명히 제 질문은 간단하지만 온라인에서 대답을 찾을 수 없었습니다. 따라서 여기에 있습니다 :C# XML /// Comments, <returns></returns> 태그가 어디에 있습니까?

<returns> 태그가 나타나는 XML /// 주석에서 메서드 호출을 마우스로 가리키면 <summary> 태그에 포함 된 모든 내용이 IntelliSense로 표시된다는 것을 알았지 만 반환 태그가 아닙니다.

<returns> 태그는 어디서 들어 왔습니까?

감사합니다.

답변

26

보기에서 메소드를 볼 때 >> 객체 브라우저

당신이 코멘트에서 API 문서를 생성하는 경우, 그것은 바로 설명 섹션 전에 반환 값 섹션 as seen here에 표시됩니다

private int GetColumnIndex(Microsoft.Office.Interop.Excel.Worksheet worksheet, string columnName, int rowIndex, int startColumnIndex) 
    Member of MyAddIn.CommandHandlers.CommandHandler 

Summary: 
Returns the column index with specified name and in specified row 

Parameters: 
worksheet: Target worksheet 
columnName: Column name to find 
rowIndex: Row index in which to search the column 
startColumnIndex: Start index of the column 

Returns: 
The index of column if found, else returns 0 
7

: 당신은 다음과 같이 표시됩니다.

7

컴파일시 XML 문서 파일을 빌드하도록 선택하면 XML 문서 주석에 포함 된 모든 내용이 해당 파일로 복사됩니다. Sandcastle과 같은 프로그램은 MSDN과 비슷한 HTML 문서를 작성할 수 있습니다.

내가 아는 한 Visual Studio의 IntelliSense에는 표시되지 않습니다. 그러나 거기에 무엇이든 쓰지 않는 것은 변명의 여지가 없습니다 :-). ReSharper의 Ctrl + Q는 입니다.과 같습니다.

1

다른 섹션 (기본적으로 아무 것도 예외 summary)은 IntelliSense에 나타나지 않습니다. Sandcastle과 같은 도구를 사용하여 XML에서 생성 된 문서에만 표시됩니다.

+7

실제로 사실이 아닙니다. 매개 변수 (유형 매개 변수 포함)는 소비 코드에서 매개 변수를 입력하기 바로 전에 인텔리전스에 표시됩니다. 이것은 매개 변수에 무엇을 입력해야하는지 알 수 있도록 도와주는 매우 유용한 기능입니다. – RosieC

+2

주석 처리 된 예외도 나타나지만 관련 유형이 아닌 해당 유형 만 표시합니다. – khargoosh

관련 문제