नामस्थान के लिए एक्सएमएल-प्रलेखन

Question

क्या आप नामस्थान के लिए xml-doc लिखेंगे? और यदि हां, कैसे और कहाँ?

मैं, लगता होगा अगर यह इस तरह एक लगभग खाली फ़ाइल संभव है, हो सकता है:

/// <summary> 
/// This namespace contains stuff 
/// </summary> 
namespace Some.Namespace 
{ 

} 

लेकिन होगा कि काम करता है? चूंकि आप ... "घोषित करें", या कम से कम अन्य सभी फ़ाइलों में नामस्थान का उपयोग करें ... और क्या होगा यदि आपने एक ही नामस्थान पर कहीं और एक XML-दस्तावेज़ चीज़ लिखा है? क्या कोई चलेगा? या वे किसी भी तरह विलय किया जाएगा?

Answer 1

NDoc एक विशेष NamespaceDoc प्रत्येक नाम स्थान में स्थित वर्ग को पहचानने, और कहा कि से प्रलेखन का उपयोग करके इस का समर्थन करता है। मैंने कोशिश नहीं की है, लेकिन Sandcastle एक ही चाल का समर्थन करने के लिए प्रतीत होता है।

संपादित करें: उदाहरण के लिए:

namespace Some.Namespace 
{ 
    /// <summary> 
    /// This namespace contains stuff 
    /// </summary> 
    public static class NamespaceDoc 
    { 
    } 
} 

Answer 2

नामस्थानों पर टिप्पणियां रखना संभव नहीं है।

UseNamespaceDocSummaries on http://ndoc.sourceforge.net/content/documenters.htm

Answer 3

सैंडकैसल सीधे NamespaceDoc का समर्थन नहीं करता, लेकिन अगर आप का उपयोग Sandcastle Help File Builder आप NamespaceDoc वर्ग टिम ने उल्लेख उपयोग कर सकते हैं।

namespace Example 
{ 
    /// <summary> 
    /// <para> 
    ///  Summary 
    /// </para> 
    /// </summary> 
    /// <include file='_Namespace.xml' path='Documentation/*' /> 
    internal class NamespaceDoc 
    { 
    } 
} 

SCHB भी थोड़ा वाक्य रचना प्रदान करता है और कोड फ़ाइलों से सीधे कोड उदाहरण एम्बेड करने की अनुमति देता है। एक उदाहरण _Namespace.xml:

<?xml version="1.0" encoding="utf-8" ?> 
<Documentation> 
    <summary> 
    <h1 class="heading">Example Namespace</h1> 
    <para> 
     This namespace is used in the following way: 
    </para> 

    <code source="Examples\Class.cs" lang="cs"></code> 
    <code source="Examples\Class.vb" lang="vbnet"></code> 

    <para> 
     Hopefully this helps! 
    </para> 
    </summary> 
</Documentation> 

एक्सएमएल फ़ाइल में प्रलेखन शामिल करने से आपको मदद फ़ाइल के लिए एक अलग एक्सएमएल फ़ाइल में कोड और बड़ा वर्णन में संक्षिप्त सारांश लिखने के लिए अनुमति देता है। इस तरह कोड सभी विवरणों से अव्यवस्थित नहीं है और आसानी से पठनीय रहता है।

Answer 4

यदि Mono का mdoc प्रलेखन प्रणाली का उपयोग कर, तो आप ns - *। Xml दस्तावेज़ फ़ाइलों को संपादित करके नामस्थान सदस्यों को दस्तावेज़ कर सकते हैं।

अधिक जानकारी के लिए mdoc file format documentation देखें।

Answer 5

Sandcastle सहायता फ़ाइल निर्माता नामस्थानों पर टिप्पणियों का समर्थन करता है। अपनी Sandcastle परियोजना खोलें। Project Properties विंडो में Summaries पर नेविगेट करें और Edit Namespace Summaries बटन पर क्लिक करें।

Answer 6

आप का उपयोग Doxygen में कर सकते हैं:

/// <summary> 
/// description 
/// </summary> 
namespace name{}; 

इसके अलावा, यह एक NameSpaces.cs फ़ाइल में अपने नामस्थान ऐलान करते हैं और उन्हें केवल इस फ़ाइल में टिप्पणी करने के लिए एक अच्छा अभ्यास है।