C# Tài liệu XML Liên kết trang web

Question

Có thể bao gồm một liên kết đến một trang web trong tài liệu XML không? Ví dụ, phương pháp của tôi tóm tắt như

///<Summary> 
/// This is a math function I found HERE. 
///</Summary> 
public void SomeMathThing(Double[] doubleArray) 
{ 
    ... 
} 

và khi tôi gõ

SomeMathThing(

Tôi muốn IntelliSense để hiển thị tóm tắt với các tùy chọn để bấm vào "ĐÂY" để liên kết đến một trang web bên ngoài. Điều này có thể không? Làm thế nào nó sẽ được thực hiện?

Answer 1

Hãy thử:

///<Summary> 
/// This is a math function I found <see href="http://stackoverflow.com">HERE</see> 
///</Summary> 

Answer 2

Bạn có thể bao gồm: tiền tố trong một cref để có nó đi ngang qua hoang sơ trong tài liệu Xml tạo ra để các công cụ như Innovasys Document! X và Sandcastle sẽ sử dụng nó. ví dụ.

/// <summary> 
/// This is a math function I found <see cref="!:http://stackoverflow.com">HERE</see> 
/// </summary> 

Visual Studio IntelliSense sẽ không hiển thị như một liên kết cho IntelliSense mặc dù - sẽ không có nhiều điểm như đó là một tooltip nên bạn không thể nhấp vào nó anyway.

Answer 3

Bạn có thể sử dụng cú pháp HTML tiêu chuẩn:

<a href="http://stackoverflow.com">here</a> 

Các văn bản sẽ được hiển thị trong Visual Studio.

Answer 4

Một hơi muộn trên hype-đào tạo, nhưng đây là những gì tôi phát hiện ra cho Visual Studio 2015.

mẫu của tôi trông như thế này:

/// <summary> 
    ///  Retrieves information about the specified window. 
    ///  The function also retrieves the value at a specified offset into the extra window memory. 
    ///  From <see cref="!:https://msdn.microsoft.com/en-us/library/windows/desktop/ms633585(v=vs.85).aspx">this</see> MSDN-Link. 
    ///  AHref <a href="http://stackoverflow.com">here</a>. 
    ///  see-href <see href="http://stackoverflow.com">here</see>. 
    /// </summary> 
    /// <param name="hwnd"></param> 
    /// <param name="index"></param> 
    /// <returns> 
    ///  Testlink in return: <a href="http://stackoverflow.com">here</a> 
    /// </returns> 
    public static IntPtr GetWindowLongPtr(IntPtr hwnd, int index) 
    { 
     return IntPtr.Size == 4 ? GetWindowLongPtr32(hwnd, index) : GetWindowLongPtr64(hwnd, index); 
    } 

Kết quả là:

1. Chú giải công cụ:
   • Hiển thị cref-u rl với:!, nhưng ẩn chứa "này"
   • Hides ahref-url nhưng hiển thị văn bản
   • Hides seehref url và văn bản

---

2. Trình duyệt đối tượng:
   • Hiển thị url cref bằng !:, nhưng ẩn "này" (không nhấp vào thể)
   • Hides ahref-url nhưng hiển thị văn bản (không nhấp vào được) url và văn bản (không nhấp vào được)
   • Hides seehref

---

3. ReSharper (CTRL + SHIFT + F1, Command ReSharper.ReSharper_QuickDoc)
   • Hides cref-url với:!, Nhưng cho thấy "này" (không thể nhấp)
   • Liệu giờ đây giải thích ahref-url (Phiên bản từ năm 2016 và mới hơn)
   • Hides seehref url và văn bản (không nhấp được)

Kết luận: tốt nhất một, như Heiner chỉ ra, sẽ là

See <a href="link">this link</a> for more information. 

Cập nhật Như Thomas Hagström đã chỉ ra, Resharper hiện hỗ trợ URL có thể nhấp a href. Đã cập nhật ảnh chụp màn hình tương ứng.