2012-02-21 21 views
6

Trong chú thích C# XML bình luận của tôi là <return>, tôi muốn đầu ra (Tôi đang sử dụng Sandcastle) để chỉ định Loại được trả lại, nhưng tôi không thể tìm ra cách Để làm việc đó.Cách xác định Loại trong một chú thích XML <return> nhận xét

psuedo Ví dụ:

///<summary> 
///Serves as a hash function for a particular type. 
///</summary> 
///<returns **Type="System.Int32"**> 
///A hash code for the current Object. 
///</returns> 
public virtual int GetHashCode(){...} 

Ví dụ trên là một mô hình của những gì tôi đoán là để nói Sandcastle làm thế nào để xác định kiểu trả về mà được diễn tả trong phần Syntax các tài liệu - không như vậy.

Để rõ ràng, đây là ảnh chụp màn hình tài liệu của MSDN về phương thức GetHastCode() hiển thị loại trả về mà tôi đang quay.

Chúng ta có phải chỉ định Loại, hoặc có thể chỉ định Loại (tương tự ví dụ giả) và để Sandcastle xác định cách hiển thị/định dạng đầu ra - tương tự như cách Sandcastle tự động hiển thị/định dạng Kiểu cho tham số thông qua thẻ <param>.

enter image description here

+0

Tuy nhiên, để biến từ "đối tượng" thành tham chiếu đến loại có liên quan, bạn cần phải viết: '/// Mã băm cho hiện tại < –

+0

Tôi muốn cũng biết điều này, tôi có một API sử dụng 'JsonResult ' nhưng T là một kiểu ẩn danh. Mọi cách tôi cố gắng xác định loại khác với động chạy vào lỗi. – Andrew

Trả lời

2

This post (tháng 7 năm 2011) có một phản hồi nào từ Eric Woodruff (SHFB Tác giả) liên quan đến việc thiếu các kiểu trả về được hiển thị bên trong <return> tag:

Sandcastle không làm cho loại thông tin cho sự trở lại thông tin và tôi không nghĩ rằng nó đã từng có. Cung cấp thông tin là trong tệp thông tin phản ánh, các phép biến đổi XSL có thể được sửa đổi để hiển thị nó. Tôi không có thời gian để xem xét nó bây giờ nhưng có thể có thể tại một số điểm để tìm hiểu xem nó có thể.

Tôi cho rằng câu trả lời chính thức cho OP của tôi là; Sandcastle không có cách tự động chỉ định Kiểu trả về nhưng, như Skeet đã ám chỉ, nó có thể có thể thực hiện điều này bằng cách sửa đổi các phép biến đổi XSL.

4

Bạn không nên cần phải xác định nó trong tài liệu XML - sau khi tất cả, đó sẽ là không cần thiết, cho rằng đó là trong tờ khai phương pháp.

Tôi nghi ngờ đó là vấn đề tinh chỉnh phong cách Sandcastle nếu bạn thực sự muốn nó - nhưng bạn có thấy nó đặc biệt hữu ích không? Nó không giống như người dùng không thể chỉ cần nhấp vào kiểu trả về trong chữ ký phương thức. (Ít nhất đó là những gì có vẻ là trường hợp cho phong cách trong Prototype SHFB. Xem Noda Time documentation cho một ví dụ về những gì mà trông như thế nào.)

Trong MSDN, sau đó phương pháp chữ ký không có liên kết (ít nhất không có trong Chrome, tôi không biết liệu nó có khác trong IE) nhưng cá nhân tôi muốn nó nằm trong chữ ký thay vì để làm lộn xộn tài liệu thực tế.

+0

Tôi nghe bạn @ dự phòng.Tôi đã đến từ quan điểm rằng kể từ khi MSDN/Sandcastle redundantly xác định các loại trong phần tham số, tôi giả định có một cách tích hợp để xác định các loại cho các giá trị trả về là tốt. – Jed