Tag: xml-documentation

XML-Dokumentation ist der Weg zur Generierung von Dokumentation aus Kommentaren im code, um eine XML-formatierte Datei, die angezeigt werden können, mit jeder Methode, für z.B. eine web-Seite.

So erzeugen Sie C# - Dokumentation in eine CHM-oder HTML-Datei?

Anzahl der Antworten 4 Antworten
Gibt es einen Weg zu erzeugen, der eine lesbare Dokument-Datei aus der Dokumentation auf den code direkt aus Visual Studio? (auch in Anbetracht 2010) Code Beispiel: ///<summary> ///Convert a number to string ///</summary> ///<param name="number">An integer number

Mithilfe von doxygen zur Erstellung der Dokumentation für die bestehenden C# - code mit XML-Kommentaren

Anzahl der Antworten 1 Antworten
Habe ich gelesen überall, dass doxygen ist der Weg zu gehen für die Generierung von Dokumentation für C# - code. Ich habe eine einzige Schnittstelle, die ich dokumentieren wollen ersten (baby -) Schritte, und es hat bereits

Bauen Sandburgen Dokumentation Beim Bau Visual Studio-Projekt

Anzahl der Antworten 4 Antworten
Ich bin mit dem Sandcastle Help File Builder an output meines C# - XML-DOC-Datei auf der Website format. Wie kann ich erreichen das samething von der Kommandozeile aus, so dass ich hinzufügen kann, diese als ein Ereignis

Wie kann ich mich auf ein C# - Schlüsselwort in der XML-Dokumentation?

Anzahl der Antworten 1 Antworten
<see cref="switch" />, zum Beispiel, funktioniert nicht - ich bekomme die Compilerwarnung: XML comment on ... has syntactically incorrect cref attribute 'switch' Kontext für diejenigen, die interessiert sind... ///<summary>Provides base functionality for hand-coded abstractions of API method

Möglichkeiten zum synchronisieren von Schnittstelle und Implementierung Kommentare in C#

Anzahl der Antworten 9 Antworten
Gibt es automatische Möglichkeiten zur Synchronisierung von Kommentaren zwischen einer Schnittstelle und Ihrer Implementierung? Ich bin derzeit dokumentieren Sie beide und möchte das nicht manuell synchron zu halten. UPDATE: Betrachten Sie diesen code: interface IFoo{ ///<summary> ///Commenting

Wie erstelle ich xml-Dokumentation in Visual Studio 2012

Anzahl der Antworten 4 Antworten
Wie kann ich das generieren von Dokumentation meiner C# - Anwendung in Visual Studio 2012, wie Eclipse funktioniert? Was haben Sie versucht? (Es ist etwas ungewöhnlich zu veröffentlichen müssen Sie die XML-Dokumentation für eine web-Anwendung ist, IMO.

Wie schreiben Sie Kommentare / Dokumentation für Variablen / Felder / Listen in VS 2010?

Anzahl der Antworten 6 Antworten
Es ist ///<summary> ///This is summary for some class or method ///</summary> Dokumentation für Klassen oder Methoden. Aber wie schreibt man dieses auch für einfache Variablen oder Listen? Ich benutze Visual Studio 2010 und wenn ich den

Wie dokumentieren Sie die Struktur von XML-Dateien

Anzahl der Antworten 6 Antworten
Wenn es darum geht zu dokumentieren, die Struktur von XML-Dateien... Einer meiner co-Arbeiter hat es in eine Word-Tabelle. Anderen fügt die Elemente in ein Word-Dokument mit Kommentaren wie diesem: <learningobject id="{Learning Object Id (same value as the

Referenzieren von generischen Klassen und Methoden in der XML-Dokumentation

Anzahl der Antworten 7 Antworten
Beim schreiben von xml-Dokumentation, die Sie verwenden können <see cref="something">something</see>das funktioniert natürlich. Aber wie Sie auf eine Klasse oder eine Methode mit generischen Typen? public class FancyClass<T> { public string FancyMethod<K>(T value) { return "something fancy"; }

XML-Dokumentation für einen Namespace

Anzahl der Antworten 6 Antworten
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 {

Wie kann die Xml-Dokumentation für Web Api eine Dokumentation von außerhalb des Hauptprojekts enthalten?

Anzahl der Antworten 5 Antworten
Den Dokumentation für die Aktivierung XmlDoc integration in Ihre Web Api-Projekte anscheinend nur mit Situationen umgehen, wo Sie alle Ihre API-Typen sind Teil des WebApi-Projekt. Es behandelt insbesondere, wie die Umleitung der XML-Dokumentation zu App_Data/XmlDocument.xml - und

Wie man einen Zeilenumbruch in der C # .NET Dokumentation hinzufügt

Anzahl der Antworten 4 Antworten
Diese sollte viiiiel einfacher... Möchte ich hinzufügen, dass eine "codierte" Zeilenumbruch", um die XML-Dokumentation in meinem code ///<summary> ///Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt; ///Rather than return SQL, this

Die Zusammenfassung wird in der Baugruppe nicht angezeigt, wenn sie als Referenz hinzugefügt wird

Anzahl der Antworten 3 Antworten
Habe ich eine "Class Library" in C#, das hat viele Funktionen, die mit der Zusammenfassung (XML-dokumentationskommentare). Beispielsweise ///<summary> ///Adds the two numbres ///</summary> public void Add() { //statements } wenn ich die Funktion nutzen, die in dem

Wie exportiere ich die Codedokumentation in C # / VisualStudio 2008?

Anzahl der Antworten 6 Antworten
Ich habe immer eine Stelle zu schreiben, netten Kommentaren im code für die Klassen und Methoden mit den C# - xml-syntax. Ich habe immer erwartet, dass leicht in der Lage sein zu exportieren, um Sie später auf.

Beziehen Sie sich auf einen generischen Typ eines generischen Typs in der C # XML-Dokumentation?

Anzahl der Antworten 5 Antworten
Schreiben einige XML-Dokumentation für ein Prädikat helper-Klasse. Aber ich kann nicht herausfinden, ich kann beziehen sich auf eine Expression<Func<T, bool>> ohne dabei einen syntax-Fehler. Ist es überhaupt möglich? Ich habe dies ausprobiert: <see cref="Expression{Func{T, bool}}"/> Aber ich

Wie kann man einen Konstruktor in einer generischen Klasse richtig kommentieren?

Anzahl der Antworten 2 Antworten
Was ist die richtige Art und Weise zu kommentieren? VS beschwert sich: ///<summary> ///Initializes a new instance of the <see cref="Repository"/> class. ///</summary> ///<param name="unitOfWork">The unit of work.</param> public Repository(IUnitOfWork unitOfWork) { this.UnitOfWork = unitOfWork; } Warnung