XML-Dokumentation für einen Namespace

Würden Sie schreiben von xml-doc für einen namespace? Und wenn ja, wie und wo?

Ich würde denken, wenn es möglich ist, vielleicht eine fast leere Datei wie dieser:

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

}

Aber, dass die Arbeit? Seit Sie... "erklären", oder zumindest den Namensraum, in allen anderen Dateien auch... und was würde passieren, wenn Sie schrieb eine xml-Dokumentation, was irgendwo anders auf der gleichen namespace? Würde ein Weg sein? Oder würden Sie verschmolzen irgendwie?

InformationsquelleAutor der Frage Svish | 2009-04-27

  1. 32

    NDoc unterstützt dies durch die Anerkennung einer besonderen NamespaceDoc Klasse befindet sich in jedem namespace, und mit der Dokumentation aus. Ich habe es nicht ausprobiert, aber Sandcastle erscheint zur Unterstützung der gleiche trick.

    Edit:
    Zum Beispiel:

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

    InformationsquelleAutor der Antwort Tim Robinson

  2. 24

    Sandcastle unterstützt nicht die NamespaceDoc direkt, aber wenn Sie Sandcastle Help File Builder können Sie die NamespaceDoc Klasse erwähnt. Tim.

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

    SCHB erstreckt sich auch die syntax leicht und ermöglicht die Einbettung code-Beispiele, die direkt von code-Dateien. Ein Beispiel _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>

    Einschließlich der Dokumentation in XML-Datei können Sie schreiben kurze Zusammenfassung in code und größer Beschreibung in einer separaten XML-Datei die Hilfe-Datei. Auf diese Weise ist der code nicht überladen mit allen details und leicht lesbar bleibt.

    InformationsquelleAutor der Antwort Mikko Rantanen

  3. 13

    Sandcastle Help File Builder unterstützt get Kommentare über namespaces. Öffnen Sie Ihre Sandcastle-Projekt. In Project Properties Fenster navigieren Sie zu Summaries und klicken Sie auf die Edit Namespace Summaries - Taste.

    XML-Dokumentation für einen Namespace

    InformationsquelleAutor der Antwort Norbert Szenasi

  4. 1

    Können Sie es tun in doxygen mit:

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

    Auch, es ist eine gute Praxis, erklären sich mit den namespaces in einer NameSpaces.cs-Datei und kommentieren Sie nur in dieser Datei.

    InformationsquelleAutor der Antwort Adrian Lopez

  5. 0

    Ist es nicht möglich, Kommentare auf namespaces.

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

    InformationsquelleAutor der Antwort Kirtan

  6. 0

    Wenn mit Mono's mdoc Dokumentationssystem, können Sie Dokument-namespace Mitglieder durch die Bearbeitung der ns-*.Dokumentation zu xml-Dateien.

    Sehen die mdoc-Datei-format-Dokumentation für mehr details.

    InformationsquelleAutor der Antwort jonp

Schreibe einen Kommentar