Laden...

NDoc bei überladenen Methoden

Erstellt von mosspower vor 15 Jahren Letzter Beitrag vor 15 Jahren 837 Views
mosspower Themenstarter:in
456 Beiträge seit 2007
vor 15 Jahren
NDoc bei überladenen Methoden

Hallo,

gibt es einen eleganten Weg (also mit Verweisen) bei überladenen Methoden für NDoc - am besten sollte der Designer auch gleich damit zurechtkommen.

Ich mache das bisher immer so:


    /// <summary>
    /// Set the text bla
    /// </summary>
    /// <param name="text">The text</param>
    /// <param name="cultureInfo">The CultureInfo object</param>
    public static void SetText(String text, CultureInfo cultureInfo) {
      // do my work
    }

    /// <summary>
    /// <see cref="ResourceUtil.SetText(String, CultureInfo)"/>
    /// </summary>
    /// The current culture will be used
    public static void SetText(String text) {
      ResourceUtil.SetText(text, Thread.CurrentThread.CurrentCulture);
    }

Das ist ein kleines Beispiel zur Veranschaulichung. Was ich irgendwie möchte ist, ob ich jetzt z.B. für Parameter cultureInfo die Beschreibung in der referenzierten Methode inkludieren kann. Wenn ich das so lasse wie oben, dann zeigt mir der Designer lediglich den Summary text und den Zusatztext, jedoch nicht die Parameterbeschreibungen der "Basis-Methode". Geht das irgendwie (außer kopieren natürlich 😉)

Gruß und danke schon mal im Voraus für etwaige Antworten

Gelöschter Account
vor 15 Jahren

das geht klar und zwar so:


  
    /// <summary>
    /// Set the text bla
    /// </summary>
    /// <param name="text">The text</param>
    /// <param name="cultureInfo">The CultureInfo object</param>
    public static void SetText(String text, CultureInfo cultureInfo) 
    {
      // do my work
    }

    /// <summary>
    /// <see cref="ResourceUtil.SetText(String, CultureInfo)"/>
    /// </summary>
    /// <param name="text">
    /// <see cref="ResourceUtil.SetText(String, CultureInfo)"/>
    /// </param>
    public static void SetText(String text) 
    {
      ResourceUtil.SetText(text, Thread.CurrentThread.CurrentCulture);
    }


anders gehts nicht denn:

/// &lt;summary&gt;  
/// &lt;see cref=&quot;ResourceUtil.SetText(String, CultureInfo)&quot;/&gt;  
/// &lt;/summary&gt;  

heißt das er sich nur summary holen soll.
allerdings weiß ich nicht ob ndoc das versteht. Und deshalb nimm lieber "Microsoft Sandcastle" mach genau das gleiche. Erstellt z.b. Dokus im MSDN style. Heißt nicht ohne Grund "ndoc killer" ( mal bei google eingeben 😁 ) Das wird auf von Microsoft intern eingesetz zum Doku erstellen.