Ich arbeite mit Web-API-Projekt, die Ebenen enthalten (API, Domain, Repository, DTO, Entitäten). Ich möchte meinen Quellcode für jede Ebene dokumentieren. Ich habe begonnen, jede Funktion für jede Schicht zu kommentieren. Ist es ein guter Weg? Welches ist die beste Technik oder Tools zum Erstellen und Verwalten von genauen, professionellen Qualitätsdokumentation für meinen Quellcode (C# -Projekt).Qualitätsdokumentation für Quellcode in C# -Projekt?
Beste ist in der Tat Zusammenfassungen für alle Methoden/Klassen in Ihrem Code in XML-Format zu schreiben, wie folgt aus:
/// <summary>
/// This class performs an important function.
/// </summary>
public class MyClass{}
Weitere Informationen: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments
Wenn diese XML-basierten Kommentare verwenden, können Sie auch Verwenden Sie verschiedene Tools zum Generieren einer vollständigen Dokumentation. Persönlich habe ich DoxyGen verwendet. Es ist ein Tool, das basierend auf den Kommentaren und Zusammenfassungen in Ihrem Code eine vollständige HTML-Dokumentation generiert.