Ad alanı için XML belgeleri

Question

Bir ad alanı için xml-doc yazar mısınız? Ve eğer evet ise, nasıl ve nerede?

belki böyle neredeyse boş bir dosya mümkün olup olmadığını, düşünürdüm:

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

} 

Ama olacak bu işe? Siz "declare" ya da en azından isim alanını diğer tüm dosyalarda da kullanmanız ... ve aynı ad alanında başka bir yerde bir xml-dokümantasyon yazdıysanız ne olur? Biri gider miydi? Yoksa bir şekilde birleşecekler mi?

Answer 1

Ndoc her ad alanında bulunan özel bir NamespaceDoc sınıf tanıyan ve bu belgelere kullanarak bu destekler. Denemedim ama Sandcastle aynı numarayı destekliyor gibi görünüyor.

Düzenleme: Örneğin :

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

Answer 2

İsim alanlarında yorum yapmak mümkün değildir.

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

Answer 3

Sandcastle doğrudan NamespaceDoc desteklemez, ancak kullanırsanız Sandcastle Help File Builder Tim bahsettiği NamespaceDoc sınıfını kullanabilirsiniz.

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

SCHB da biraz sözdizimi uzanır ve kod dosyalarından düz kod örneklerini gömme izin verir. Bir örnek _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> 

XML dosyasında belgelere eklemek, yardım dosyası için ayrı bir XML dosyasında kod ve daha büyük açıklamasında kısa bir özet yazmak için izin verir. Bu şekilde kod, tüm detaylarla dağınık değildir ve kolayca okunabilir kalır.

Answer 4

Monomdoc dokümantasyon sistemi kullanıyorsanız, ns - *. Xml belge dosyalarını düzenleyerek ad alanı üyelerini belgeleyebilirsiniz.

Daha fazla ayrıntı için mdoc file format documentation'a bakın.

Answer 5

Sandcastle Yardım Dosyası Oluşturucu ad alanlarındaki yorumları destekler. Sandcastle projeni aç. Project Properties penceresinde Summaries'a gidin ve Edit Namespace Summaries düğmesine tıklayın.

Answer 6

kullanarak doxygen bunu yapabilirsiniz:

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

Ayrıca, bir NameSpaces.cs dosyasında namespaceler ve sadece bu dosyada bunları yorum yapmak için iyi bir uygulamadır.