C # XML 설명서 웹 사이트 링크

C # XML 설명서 웹 사이트 링크

---

XML 문서에 웹 사이트에 대한 링크를 포함시킬 수 있습니까? 예를 들어, 내 방법은 다음과 같이 요약됩니다.

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

내가 입력하면

SomeMathThing(

IntelliSense가 "HERE"를 클릭하여 외부 웹 사이트에 연결하는 옵션과 함께 요약을 표시하기를 원합니다. 이게 가능해? 어떻게 하시겠습니까?

---

시험:

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

---

과대 광고에 조금 늦었지만 Visual Studio 2015에서 찾은 것이 있습니다.

내 샘플은 다음과 같습니다.

    /// <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);
    }

결과는 다음과 같습니다.

1. 툴팁 :
   • ! :와 함께 cref-url을 표시하지만 "this"를 숨 깁니다.
   • ahref-url을 숨기지 만 텍스트를 표시합니다
   • seehref URL 및 텍스트를 숨 깁니다.

---

2. 객체 브라우저 :
   • ! :와 함께 cref-url을 표시하지만 "this"를 숨 깁니다 (클릭 할 수 없음)
   • ahref-url을 숨기지 만 텍스트를 표시합니다 (클릭 할 수 없음)
   • seehref URL 및 텍스트를 숨 깁니다 (클릭 할 수 없음)

---

3. ReSharper (CTRL + SHIFT + F1, 명령 ReSharper.ReSharper_QuickDoc)
   • ! :로 cref-url을 숨기지 만 "this"(클릭 할 수 없음)를 표시합니다
   • ahref-url을 해석하지 않습니다 (2016 이후 버전)
   • seehref URL 및 텍스트를 숨 깁니다 (클릭 할 수 없음)

결론 : Heiner가 지적했듯이 가장 좋은 것은

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

업데이트 Thomas Hagström이 지적했듯이 Resharper는 이제 클릭 가능한 a-href URL을 지원합니다. 이에 따라 스크린 샷이 업데이트되었습니다.

---

표준 HTML 구문을 사용할 수 있습니다.

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

텍스트가 Visual Studio에 표시됩니다.

---

Cref에! : 접두사를 포함시켜 생성 된 Xml 문서에서 수정되지 않은 상태로 전달하여 Innovasys Document 와 같은 도구를 사용할 수 있습니다 ! X 와 Sandcastle이 사용합니다. 예 :

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

Visual Studio intellisense는 그것을 intellisense에 대한 링크로 표시하지 않습니다. 툴팁이므로 아무리 강조해도 클릭 할 수는 없습니다.

참고 URL : https://stackoverflow.com/questions/6960426/c-sharp-xml-documentation-website-link