2008-10-01 10 views
59

मैंने कुछ समय पहले Sandcastle का उपयोग शुरू किया था ताकि हमारी परियोजनाओं में से एक के लिए एक दस्तावेज़ीकरण वेबसाइट तैयार की जा सके। यह काफी अच्छी तरह से काम कर रहा है लेकिन हमने हमेशा हमारी परियोजना में कक्षाओं, विधियों, गुणों (...) के लिए केवल दस्तावेज लिखे हैं और समग्र परियोजना और परियोजना भागों/मॉड्यूल/नामस्थानों के लिए पूरी तरह से अलग दस्तावेज थे। यह अच्छा होगा अगर मैं उस दस्तावेज़ीकरण को एक साथ जोड़ सकता हूं और जेनरेट की गई सहायक फाइलों में संबंधित दस्तावेज जोड़ सकता हूं लेकिन मैं यह नहीं समझ सकता कि इसे कैसे किया जाए।एक नेट प्रोजेक्ट (Sandcastle) पर नेमस्पेस दस्तावेज़?

बस नाम स्थान घोषणा करने के लिए टिप्पणी जोड़ने काम करने के लिए (सी #) नहीं लगता है:

/// <summary> 
/// My short namespace description 
/// </summary> 
namespace MyNamespace { ... } 

किसी को भी ऐसा करने के तरीके पता है? मुझे पता है कि यह किसी भी तरह से संभव है और यह वास्तव में अच्छा होगा ... :)

उत्तर

70

सैंडकैसल भी ndoc शैली नाम स्थान प्रलेखन, जो आप स्रोत फ़ाइलों में प्रलेखन छड़ी करने की अनुमति देता का समर्थन करता है उस वर्ग के लिए डॉक्टर टिप्पणी नामस्थान के लिए उपयोग की जाएगी।

कक्षा को स्वयं दस्तावेज़ों में दिखने से रोकने के लिए इसे [कंपाइलर जेनरेटेड] विशेषता के साथ सजाएं।

उदाहरण:

namespace Some.Test 
{ 
    /// <summary> 
    /// The <see cref="Some.Test"/> namespace contains classes for .... 
    /// </summary> 

    [System.Runtime.CompilerServices.CompilerGenerated] 
    class NamespaceDoc 
    { 
    } 
} 

सैंडकैसल में काम मद स्थित है here.

+6

मैं इसे प्रदूषण पर अधिक पसंद करता हूं विन्यास फाइलें: | परियोजना में भी तत्काल दिखाई दे रहा है। – Groxx

+0

मैं विजुअल स्टूडियो परिवर्धन का उपयोग करता हूं, इसलिए यह एक वास्तविक आशीर्वाद है। धन्यवाद! –

+0

@Groxx से सहमत हुए। मुझे लगता है कि दृश्यता भी इस विधि पर Sandcastle परियोजना की सेटिंग्स पर भी लागू होती है। – krillgar

19

यदि आप Sandcastle Help File Builder का उपयोग करते हैं तो नामस्थान सारांश दर्ज करने के लिए एक संवाद है। (जाहिर है यह भी एक विशिष्ट वर्ग परिभाषित करने के लिए समर्थन करते हैं, लेकिन मैं इसे पसंद नहीं करेंगे ..)

सुविधा सूची से

:

परियोजना सारांश की परिभाषा और नाम स्थान सारांश टिप्पणी है कि में दिखाई देगा मदद फ़ाइल आप आसानी से इंगित कर सकते हैं कि कौन से नामस्थान में सहायता फ़ाइल से शामिल या बहिष्कृत हैं। के लिए नेमस्पेसडॉक क्लास के माध्यम से नेमस्पेस टिप्पणियों को प्रत्येक नामस्थान के भीतर नामस्थान टिप्पणियों को निर्दिष्ट करने के लिए समर्थन भी शामिल है।

+5

विकल्प प्रोजेक्ट गुणों में है> टिप्पणियां> नामस्थान स्पेस –

+6

यह वास्तव में नवीनतम प्रोजेक्ट (वर्तमान में 1.9.3.0) में प्रोजेक्ट प्रॉपर्टीज> सारांश> नाम स्पेससमरी में बदल गया है। –

+0

पुराना विषय, लेकिन शायद यह किसी के लिए सहायक होगा। यह संस्करण 17.1.28.0 में भी काम करता है। पारितोषिक के लिए धन्यवाद। –

7

Sandcastle Help File Builder का उपयोग करें।

<namespaceSummaryItem name="System" isDocumented="True"> 
    Generic interfaces and helper classes. 
</namespaceSummaryItem> 

संदर्भ:: यह

उदाहरण एक्सएमएल परियोजना फ़ाइल में नाम स्थान का विवरण निर्दिष्ट कर सकते हैं

बस एक गैर सरकारी वर्ग नाम स्थान आप दस्तावेज़ के लिए चाहते हैं, उसमें NamespaceDoc कहा जाता है बनाते हैं, और xml:

+4

उपर्युक्त उदाहरण का लिंक बदल गया है, अब यह यहां पाया जा सकता है: http://lokad.svn.sourceforge.net/viewvc/lokad/Platform/Trunk/SafetyStockCalc/Lokad.SafetyStock.shfb –

1

आप संदर्भ कि जिस तरह से नहीं कर सकते जोड़ने - NamespaceDoc.cs उदाहरणों के माध्यम से यह कर

यानी

/// <summary> /// Concrete implementation of see cref="IInterface" using see cref="Concrete"
/// </summary> class NamespaceDoc { }

see here

+0

यह इंटेलिजेंस के साथ काम किया। – xvan

3

मुझे पता है कि यह एक पुरानी पोस्ट है, लेकिन यह किसी और के लिए मदद की जा सकती है।

Following this link, आप अपने प्रोजेक्ट में गैर-सार्वजनिक कक्षा जोड़ने की आवश्यकता के बिना नामस्थानों के लिए विवरण सेट कर सकते हैं।

नामस्थान सारांश संपादित करने के लिए, SHFB में प्रोजेक्ट प्रॉपर्टी टैब के भीतर सारांश अनुभाग का विस्तार करें। आपको "नेमस्पेससमरी" नाम की एक सेटिंग दिखाई देगी, जो प्रारंभ में मूल्य दिखाती है, "(कोई नहीं)"। इसे चुनने के लिए सेटिंग पर क्लिक करें और एक इलिप्सिस प्रतीक (...) दिखाई देने वाला बटन दिखाई देता है। नामस्थान सारांश संवाद बॉक्स में, नीचे बताए अनुसार प्रदर्शित करने के लिए इस बटन को क्लिक:

enter image description here

0

मैं एक के लिए दस्तावेज़ "बाहरी एक्सएमएल टिप्पणियाँ फ़ाइलें" देखते हैं। की तरह एक स्कीमा दिखा रहे हैं: यह एक अलग फाइल में रखा जाता है

<doc> 
    <assembly/> 
    <members> 
     <member/> 
    </members> 
</doc> 

, क्या विस्तार (xml/एएमएल) होगा और यह दृश्य स्टूडियो परियोजना में इस्तेमाल किया जा सकता है?

संबंधित मुद्दे