So erstellen Sie eine /// Zusammenfassung

Wie generiere ich solche Zusammenfassungen in Visual Studio?

/// <summary>
///  Returns a number
/// </summary>
/// <param name="num"></param>
/// <returns></returns>

Geben Sie ///vor Ihrer Methode, Eigenschaft usw. ein. VS generiert die Kommentarblöcke automatisch.

Wie bereits erwähnt, fügt Visual Studio die Dokumentationsvorlage standardmäßig automatisch hinzu, wenn Sie drei Schrägstriche hintereinander über der Elementdeklaration eingeben. Wenn auf das Mitglied Attribute angewendet wurden, geben Sie die Schrägstriche in die Zeile über den Attributen ein.

Beachten Sie jedoch, dass eines der nützlichsten Dinge, die für eine Methode (oder einen Konstruktor, eine Eigenschaft usw.) dokumentiert werden müssen, die Ausnahmen sind, die die Methode möglicherweise generiert. Diese können durch Eingabe ///<exceptionnach dem Rest der Dokumentation hinzugefügt werden . Wenn Sie den Intellisense-Vorschlag akzeptieren, erhalten Sie einen Platz für den Ausnahmetyp als XML-Attribut, und Sie können die Umstände im Inhalt des Ausnahmeelements eingeben.

Wenn einer Methode Parameter hinzugefügt werden, nachdem die Dokumentation bereits erstellt wurde, ist Intellisense auch sehr hilfreich, wenn Sie den neuen Parameternamen eingeben, wenn Sie ihn zur Dokumentation hinzufügen. Es ist eine ziemlich raffinierte Funktion.

Verwenden Sie Tools wie GhostDoc . Es wird generiert, indem Sie mit der rechten Maustaste auf einen Methodennamen klicken.

Ich kann GhostDoc empfehlen , um dies noch einfacher zu machen.

Geben Sie dreimal / ein, und Visual Studio füllt den Rest des Codes aus.

Wie George sagt, wird /// in der Zeile oben automatisch generiert.

Abgesehen von der Kommentarvorlage für das Boilerplate würde ich empfehlen, einen Blick auf die anderen Tags zu werfen, die Sie möglicherweise verwenden: http://msdn.microsoft.com/en-us/library/5ast78ax.aspx

Dies kann in Kombination mit anderen Tools wie Sandcastle verwendet werden, um automatisch CHM-Anleitungen usw. zu erstellen.

Setzen Sie den Cursor auf die Zeile direkt vor der Methode oder Klasse, die Sie dokumentieren möchten, und geben Sie "///" ein. Visual Studio generiert die XML-Dokument-Tags, und Sie können die Details eingeben.

Geben Sie in der Zeile vor Ihrer Eigenschaft / Methode / etc einfach /// ein, und Visual Studio fügt die XML-Tags automatisch hinzu.

Für Controller: Verwenden Sie 3 Schrägstriche vor Methoden, dh ///, wodurch ein solches Zusammenfassungs-Tag generiert wird.

     /// <summary>
     /// 
     /// </summary>
     /// <param name="searchKey"></param>
     /// <returns></returns>

Für Modelle: Verwenden Sie 3 Schrägstriche vor einer automatischen Eigenschaft, dh ///, die ein Zusammenfassungs-Tag wie dieses generiert.

     /// <summary>
     /// 
     /// </summary>