C# XML /// Nhận xét, trong đó <returns></returns> thẻ hiển thị?

Question

Tôi hiện là sinh viên lập trình và rõ ràng câu hỏi của tôi rất đơn giản, nhưng tôi không thể tìm thấy câu trả lời cho câu hỏi trực tuyến. Vì vậy, đây là:

Trong XML /// nhận xét trong C#, thẻ <returns> hiển thị ở đâu, tôi biết rằng mọi thứ có trong thẻ <summary> hiển thị trong intellisense khi bạn di chuột qua cuộc gọi phương thức, nhưng không phải thẻ trả về.

Vậy thẻ <returns> xuất hiện ở đâu?

Cảm ơn.

Answer 1

Khi bạn xem phương pháp trong Chế độ xem >> Trình duyệt đối tượng

Ví dụ: bạn sẽ thấy một cái gì đó như thế này:

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 

Answer 2

Nếu bạn tạo tài liệu API từ các ý kiến, nó sẽ hiển thị trong Return giá trị phần, as seen here, ngay trước chú phần.

Answer 3

Khi bạn chọn xây dựng tệp tài liệu XML về biên dịch, thì mọi thứ được chứa trong các nhận xét tài liệu XML sẽ được sao chép vào tệp đó. Các chương trình như Sandcastle sau đó có thể xây dựng tài liệu HTML giống như MSDN từ đó.

Nó không hiển thị trong IntelliSense của Visual Studio, theo như tôi biết. Nhưng đó không phải là lý do để không viết một cái gì đó ở đó :-). Ctrl + Q của ReSharper chẳng hạn hiện hiển thị nó.

Answer 4

Các mục khác (về cơ bản, ngoại lệ là summary) sẽ không xuất hiện trong nội dung. Chúng chỉ nhằm mục đích xuất hiện trong tài liệu được tạo ra từ XML, sử dụng một công cụ như Sandcastle.