C # XML डॉक्यूमेंटेशन वेबसाइट लिंक

144

क्या XML प्रलेखन में किसी वेबसाइट का लिंक शामिल करना संभव है? उदाहरण के लिए, मेरी विधि संक्षेप में बताई गई है

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

और जब मैं टाइप करता हूँ

SomeMathThing(

मैं चाहता हूं कि IntelliSense एक बाहरी वेबसाइट से लिंक करने के लिए "HERE" पर क्लिक करने के विकल्प के साथ सारांश दिखाए। क्या यह संभव है? यह कैसे किया जाएगा?

c# xml hyperlink

— जॉन
स्रोत

149

प्रयत्न:

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

— dizzwave
स्रोत

7

नहीं किस्मत मैं डरता हूँ। यह "यहाँ भी" प्रदर्शित नहीं किया।

— जॉन

5

हम्म, मेरी माफ़ी। मैंने थोड़ा और शोध किया ( यहां और यहां देखें ) - और ऐसा लग रहा है कि वीएस आईडीई उन हाइपरलिंक को प्रदर्शित नहीं करेगा, लेकिन सैंडकैसल जैसे एक प्रलेखन उपकरण उन्हें प्रदर्शित करने में सक्षम होंगे।

— चक्कर

2

आप सैंडकास्टल के बारे में यहाँ btw पढ़ सकते हैं । "सैंडकैसल, माइक्रोसॉफ्ट द्वारा निर्मित, एक निशुल्क उपकरण है जिसका उपयोग .NET असेंबली और उनकी एक्सएमएल टिप्पणी फाइलों से MSDN- शैली के दस्तावेज़ बनाने के लिए किया जाता है। यह कमांड-लाइन आधारित है और इसमें कोई GUI फ्रंट-एंड, प्रोजेक्ट प्रबंधन सुविधाएँ या एक स्वचालित नहीं है। निर्माण प्रक्रिया। " HTH!

— 20

1

ध्यान दें, सामग्री टैग के रूप में <see /> के समर्थन में कुछ परिवर्तनशीलता है। मैंने इसे तब और अधिक सुसंगत पाया है जब कच्चे URL को प्रदर्शित करने वाले स्व-बंद टैग के रूप में उपयोग किया जाता है। (जो वैसे भी बेहतर प्रलेखन है: जैसा कि "यहां" स्पष्टीकरण के तरीके में बहुत कुछ प्रदान नहीं कर रहा है।)

— ग्रेमलिन

3

यह वीएस 16.4.2 में काम करता है। यह सुनिश्चित नहीं किया गया है कि यह किस संस्करण में जोड़ा गया है, केवल यह कि अब आप विधि जानकारी विंडो में लिंक पर क्लिक कर सकते हैं।

— JB06

71

प्रचार-ट्रेन में थोड़ी देर हो गई, लेकिन यहाँ पर मुझे विजुअल स्टूडियो 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);
    }

परिणाम हैं:

टूलटिप:
- के साथ cref-url दिखाता है !:, लेकिन छुपाता है "यह"
- Ahref-url छुपाता है लेकिन पाठ दिखाता है
- Seehref url और पाठ छुपाता है

ऑब्जेक्ट ब्राउज़र:
- के साथ cref-url दिखाता है !:, लेकिन "यह" (क्लिक करने योग्य नहीं) छुपाता है
- Ahref-url छुपाता है लेकिन पाठ दिखाता है (क्लिक करने योग्य नहीं)
- Seehref url और पाठ छुपाता है (क्लिक करने योग्य नहीं)

ReSharper (CTRL + SHIFT + F1, कमांड ReSharper.ReSharper_QuickDoc)
- के साथ cref-url छुपाता है!:, लेकिन "यह" (क्लिक करने योग्य नहीं) दिखाता है
- अब आहेर-यूआरएल की व्याख्या करता है (2016 और नए संस्करण से)
- Seehref url और पाठ छुपाता है (क्लिक करने योग्य नहीं)

निष्कर्ष: सबसे अच्छा एक, जैसा कि हेनर ने बताया, होगा

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

थॉमस हागस्ट्रॉम के अपडेट के अनुसार, रिसर्पर अब क्लिक करने योग्य a-href URL का समर्थन करता है। तदनुसार स्क्रीनशॉट अपडेट किया गया।

— MHolzmayr
स्रोत

2

वास्तव में, ReSharper और CTRL + SHIFT + F1 के साथ एक यूआरएल क्लिक करने योग्य है और HTML लिंक संगत है, इसलिए यह वास्तव में सबसे अच्छा विकल्प है

— थॉमस हागस्ट्रॉम

1

धन्यवाद थॉमस Hagström, awer और स्क्रीनशॉट को अपडेट किया।

— MHolzmayr 12

26

आप मानक HTML सिंटैक्स का उपयोग कर सकते हैं:

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

पाठ को विजुअल स्टूडियो में प्रदर्शित किया जाएगा।

— हेइनर
स्रोत

5

यह सबसे अच्छा तरीका है। जैसा कि आउटपुट अभी भी विज़ुअल स्टूडियो में समझ में आएगा (यह सिर्फ पाठ दिखाता है) और लिंक सैंडकास्टल जैसे प्रलेखन टूल में काम करेगा।

— Sn --bjørn

20

आप इसमें शामिल हो सकते हैं!: एक cref में उपसर्ग यह उत्पन्न Xml प्रलेखन में अछूता से गुजरने के लिए है ताकि Innovasys दस्तावेज़ जैसे उपकरण ! एक्स और सैंडकास्टल इसका इस्तेमाल करेंगे। जैसे

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

Visual Studio intellisense यह प्रदर्शित नहीं करेगा कि intellisense के लिए एक लिंक के रूप में - बहुत ज्यादा बिंदु नहीं होगा क्योंकि यह एक टूलटिप है इसलिए आप इसे वैसे भी क्लिक नहीं कर सकते।

— fubaar
स्रोत

2

एक बिंदु होगा यदि ऑब्जेक्ट ब्राउज़र वास्तव में <see/>क्लिक करने योग्य और मान्यता प्राप्त वेबसाइट यूआरआई किसी भी तरह से बना हो (क्योंकि ऑब्जेक्ट ब्राउज़र टूलटिप नहीं है)। मैं तो बस कह रहा हूं' ;-)।

— बिंकी

6

एक टैग का उपयोग करें। उदाहरण के लिए मैंने अपनी परियोजना में इस समाधान का उपयोग किया

परिणाम यहाँ है

मेरा xml कोड है:

/// <summary>
/// This is C# XML Documentation Website Link
/// <a href="/programming/6960426/c-sharp-xml-documentation-website-link">See more</a>
/// </summary>

या "देखें" टैग का उपयोग करें। परिणाम "ए" टैग के समान है

/// <summary>
/// This is C# XML Documentation Website Link
/// <see href="/programming/6960426/c-sharp-xml-documentation-website-link">See more</see>
/// </summary>

— रामिल अलीयेव
स्रोत