Sandcastle kullanarak bir süre önce bizim projelerinden biri için Belgeleri bir web Sitesi oluşturmak için başladım. Çalışma oldukça iyi ama biz hep tek yazılı belge sınıfları, yöntemleri, özellikleri (...) bir projemiz vardı ve tamamen ayrı belgeler için genel proje ve parçaları/modüller/ad. Eğer bu belgeleri birleştirmek ve oluşturulan Yardımcısı dosyaların ilgili belgeleri ekleme yapabilsem iyi olurdu ama nasıl yapılacağını çözemedim.

Sadece beyan yürümüyor ad yorum ekleme (C#):

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

Herkes bunu nasıl biliyor mu? Olası bir şekilde ve çok güzel olacağını biliyorum... :)

Kumdan kaleyi de kaynak dosyaları: belgelere sopa sağlayan ndoc tarzı ad belgelerine destekler

Sadece halka açık olmayan bir sınıf belge için istediğiniz ad NamespaceDoc oluşturun, ve sınıf için xml doc yorum ad alanı için kullanılacak.

Belgelerinde gösterilmesini [CompilerGenerated] sınıfı kendisini önlemek için bir öznitelik ile süslüyor.

Örnek:

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

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

Kumdan kalede de iş öğesi yer almaktadır here.