Entwickler-Ecke

Programmierwerkzeuge - Automatisch Kommentargerüst über einer Funktion erstellen


ebber - Mo 20.10.08 19:05
Titel: Automatisch Kommentargerüst über einer Funktion erstellen
Hallo,

ist eine kurze Frage und wahrscheinlich auch in Sekunden gelöst, aber ich komm einfach nicht mehr dahinter.
Was muss ich tun damit mir Visual Studio automatisch sowas über meine Funktion setzt:


C#-Quelltext 
1:
2:
3:
4:
5:
6:
7:
8:
9:
 
        /// <summary>
        /// 
        /// </summary>
        /// <param name="yyy"></param>
        /// <returns></returns>
        private bool xxx(bool yyy)
        {

        }


:?:

MfG


Christian S. - Mo 20.10.08 19:14
Bei mir reicht es, wenn ich über der Methode "///" tippe, dann fügt er das ein. :nixweiss:


ebber - Mo 20.10.08 19:18
Ja, war mir auch so als wäre das so gewesen, funktioniert aber irgendwie nicht mehr :cry:

Kann man das irgendwo abstellen?

Edit: Ich habe es nun gelöst, komisches Phänomen, es funktioniert überall bloß hier nicht:


C#-Quelltext 
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
 
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;

namespace RSAB
{
    public partial class Window1
    {
        /// <summary>
        /// 
        /// </summary>
        #region RSAB


        private bool xxx(bool yyy)



Edit2: Ist mir gerade eine Idee gekommen und ich habe jetzt den Bug: VS denkt, dass die region Beschreibung die für die Funktion ist. Wenn ich diese lösche, dann gehts über der Funktion und wenn ich es dann über region mache erscheint sie dort(gesehen am Parameter der dabei war).


Ralf Jansen - Mo 20.10.08 21:13
Das Verhalten von VS ist korrekt und kein Bug oder besser es funktioniert ~as designed~.
Die XML Dokumentation ist wirklich zur Dokumentation und nicht zur Kommentierung gedacht. Also um daraus Hilfen innerhalb der IDE(Tooltip-Help) oder zur Generierung einer Standalone Hilfe (z.B. per Sandcastle) zu erstellen.

Wenn du mal in deinen Projektoptionen unter Build die Option für ein XML Documentationfile einschaltest erhälst du Warnungen für fehlende oder fehlerhafte XML Dokumentationen. Zu deiner Region Dokumentation sollte du dann eine Warnung erhalten das eine Region kein gültiges Sprachelement ist oder das die folgende Methoden doppelt dokumentiert ist.

Wenn du Regions beschreiben möchtest solltest du also einen normalen Kommentar '//' schreiben.


ebber - Mo 20.10.08 22:20
Ok, das leuchtet mir ein. Aber dann sollte doch nicht wenn ich über region /// mache, das von der Funktion darunter erscheinen?


AXMD - Di 21.10.08 07:46
Ich nehme an, dass VS die Region einfach ignoriert, und dadurch der Meinung ist, dass sich der zu erstellende XML-Kommentar auf die darunterliegende Funktion bezieht.

AXMD


Entwickler-Ecke.de based on phpBB
Copyright 2002 - 2011 by Tino Teuber, Copyright 2011 - 2026 by Christian Stelzmann Alle Rechte vorbehalten.
Alle Beiträge stammen von dritten Personen und dürfen geltendes Recht nicht verletzen.
Entwickler-Ecke und die zugehörigen Webseiten distanzieren sich ausdrücklich von Fremdinhalten jeglicher Art!