Gib über Deiner Prozedur 3 Kommentarzeichen ein und drück Enter.
Dann ersgtellt die Umgebung einen Rumpf, den Du ausfüllen musst.

Wird glaube ich beim Drüberfahren mit dem Cursor angezeigt.
LG

Nikx schrieb:

Wird glaube ich beim...

Wird im Editor nicht angezeigt.
Wenn Du aber Deinem Projekt die Eigenschaft
Projekt -> Eigenschaften -> Kompilieren
XML-Dokumentationsdatei (Haken rein) gibst, wird aus all diesen Informationen Deines Projekts eine Datei generiert, die Dein Projekt entsprechend gut beschreibt.

msdn schrieb:

Mittels des <remarks>-Tags werden Informationen über einen Typ hinzugefügt. Diese dienen als Ergänzung zu den mit <summary> angegebenen Informationen.
Diese Informationen werden im Objektkatalog angezeigt.

Optionale Parameter sollten immer zum Schluss kommen, so definierst du sie:

haiyyu schrieb:

Optionale Parameter sollten immer zum Schluss kommen

nicht Sollten sondern Müssen.
Der Compiler lässt anderes nicht zu.

BjöNi schrieb:

Ach so, also nicht unbedingt nötig...

auch die anneren Doku-Tags sind nicht unbedingt nötig.
Ich empfehle, das Zeug sparsam einzusetzen.
IN den meisten Fällen macht eine gute Benamung von Methoden und Parametern diese Kommentar-Orgien üflüssig.

In den anderen Fällen (also wo das wirklich nicht gelingt), sind Doku-Kommentare dann aber auch absolut wichtig.

Nach diesrer Richtlinie erhält man gut lesbaren Code, und Doku-Kommentare werden auch zur Kenntnis genommen, grade weil eben nicht wahllos jede Methode belabert wird.

Eine ordentliche Beschreibung der Parameter, insbesondere ihres Wertebereiches, halte ich für absolut sinnvoll, um nicht zu sagen erforderlich.
Irgensdwo ist es eine Frage des Programmierstils, außerdem kann das auch in eine DLL reingeschrieben und beim aufrufensden Programm genutzt werden.

machmal'n Beispiel. Also was reelles - nicht "MySub()" und Zeugs.
also ich zeige mal ein schlechtes Beispiel auf, aussm ObjectBrowser:

ObjectBrowser schrieb:

Sub CopyTo(ByVal array() As T, ByVal arrayIndex As Integer)
Member von System.Collections.Generic.ICollection(Of T)
Zusammenfassung:
Kopiert die Elemente von System.Collections.Generic.ICollection(Of T) in ein System.Array, beginnend bei einem bestimmten System.Array-Index.

Parameter:
array: Das eindimensionale System.Array, das das Ziel der aus System.Collections.Generic.ICollection(Of T) kopierten Elemente ist.Für System.Array muss eine nullbasierte Indizierung verwendet werden.
arrayIndex: Der nullbasierte Index in array, an dem das Kopieren beginnt.

Ausnahmen:
System.ArgumentNullException: array hat den Wert null.
System.ArgumentOutOfRangeException: arrayIndex ist kleiner als 0.
System.ArgumentException: array ist mehrdimensional.- oder -Die Anzahl der Elemente in der Quelle System.Collections.Generic.ICollection(Of T) ist größer als der verfügbare Speicherplatz ab arrayIndex bis zum Ende des array, das als Ziel festgelegt wurde.- oder -Typ T kann nicht automatisch in den Typ des Ziel-array umgewandelt werden.

Findest du in diesem Gelaber ieine nicht-selbstverständliche Information?

Was denken die eigentlich, was ich wohl vorhab, wenn ich mw. so eine Methode aufrufe:Käsekuchen backen?
Ich hab bei solche "Dokumentation" immer das Gefühl, man hält mich für bescheuert.

oder dieses hier:

ObjectBrowser schrieb:

Public Function Contains(ByVal value As String) As Boolean
Member von System.String
Zusammenfassung:
Gibt einen Wert zurück, der angibt, ob das angegebene System.String-Objekt in dieser Zeichenfolge vorkommt.

Parameter:
value: Die zu suchende Zeichenfolge.

Rückgabewerte:
true, wenn der value-Parameter in dieser Zeichenfolge vorkommt oder value eine leere Zeichenfolge ("") ist, andernfalls false.

Ausnahmen:
System.ArgumentNullException: value hat den Wert null.

Das Gelaber ist IMO komplett üflüssig, denn die Bedeutung von String.Contains(value As String) ist erfreulicherweise vollständig selbsterklärend.

Also was ich anrege ist:
Nicht stupide nach Schema F das Formular ausfüllen, was VisualStudio da hingeneriert, wenn man ''' eingibt, sondern Kopf anmachen und denken: "welche Info braucht der Leser?"
Und wenn was gefunden, was sich nicht aus dem Code-Design direkt ergibt, dann zunächst dieses Code-Design überprüfen.
Und erst dann was hinzukommentieren, wenn man kein perfektes Design hinbekommt.

Beispiele für gelungenes "perfektes Design" im o.g. Sinne: String.Contains(value), String.IndexOf(), .EndsWith(), ... um mal bei String zu bleiben.
Wie gesagt: Da diese Methoden perfekt designed sind, sind die daran angefügten Doku-Kommentare überflüssiger Müll und schlechtes Beispiel.