programing

C# XML 문서 웹사이트 링크

stoneblock 2023. 11. 5. 10:51

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>

과대 선전 열차는 좀 늦었지만, 비주얼 스튜디오 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을 표시하지만 "이것"은 숨깁니다.
    • ref-url을 숨기지만 텍스트를 표시합니다.
    • 참조 URL 및 텍스트를 숨깁니다.

  1. 개체 탐색기:
    • !:를 사용하여 cref-url을 표시하지만 "이것"은 숨깁니다(클릭할 수 없음)
    • ref-url을 숨기지만 텍스트를 표시합니다(클릭할 수 없음).
    • seehref URL 및 텍스트 숨김(클릭 불가)

  1. ReSharper(CTRL+SHIFT+F1, 명령 ReSharper).ReSharper_QuickDoc)
    • !:로 cref-url을 숨기지만 "이것"을 표시합니다(클릭할 수 없음).
    • ahref-url(2016년 이후 버전)을 해석합니다.
    • seehref URL 및 텍스트 숨김(클릭 불가)

결론:하이너가 지적한 바와 같이, 가장 좋은 것은

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

업데이트 Thomas Hagström이 지적한 대로, 리샤퍼는 이제 클릭 가능한 a-href URL을 지원합니다.따라서 스크린샷이 업데이트되었습니다.

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

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

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

Innovasys Document! X와 Sandcastle 같은 도구가 사용할 수 있도록 생성된 Xml 문서에 !: 접두사를 cref에 포함할 수 있습니다.

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

Visual Studio intellense는 그것을 intellense를 위한 링크로 표시하지는 않지만, 도구 설명이므로 별 의미가 없기 때문에 클릭할 수 없습니다.

사용.<a>tag. 예를 들어 프로젝트에서 이 솔루션을 사용했습니다.

결과:

내 XML 코드:

/// <summary>
/// This is C# XML Documentation Website Link
/// <a href="https://stackoverflow.com/questions/6960426/c-sharp-xml-documentation-website-link">See more</a>
/// </summary>

또는 사용.<see>tag. 결과는 다음과 같습니다.<a>꼬리표를 매다

/// <summary>
/// This is C# XML Documentation Website Link
/// <see href="https://stackoverflow.com/questions/6960426/c-sharp-xml-documentation-website-link">See more</see>
/// </summary>

저도 노력했습니다.<see href="https://some.com/>처음에는 효과가 없었지만, 그 다음에는 시도해 보았습니다.<seealso href="https://some.url/">효과가 있었습니다.

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