Document C# codebase and publish 2.1.2
This commit is contained in:
@@ -27,6 +27,22 @@ Das BizTalk Platform Management Tool unterstützt kontrollierte Wartungsfenster
|
||||
- Regressionstests: `tests/BizTalkPlatformManagementTool.Tests`
|
||||
- PowerShell-Archiv: `archive/powershell/BizTalkPlatformManagementTool.ps1`
|
||||
|
||||
## Code-Dokumentationsstandard
|
||||
|
||||
Die vollständige C#-Codebasis in Anwendung, Installer, Packager und Regressionstests ist auf Typ- und Methodenebene mit XML-Dokumentationskommentaren versehen. Methoden dokumentieren ihre Parameter mit `<param>`, generische Typen mit `<typeparam>` und Rückgabewerte mit `<returns>`, soweit jeweils vorhanden. Die Release-Konfiguration jedes Projekts erzeugt zusätzlich eine XML-Dokumentationsdatei im jeweiligen `bin\Release`-Verzeichnis. Dadurch prüft der Compiler Syntax und Referenzen der öffentlichen Dokumentation bei jedem Release-Build.
|
||||
|
||||
Deutsche Inline-Kommentare stehen gezielt an Stellen, deren Zweck nicht allein aus dem Code hervorgeht. Dazu zählen insbesondere:
|
||||
|
||||
- sichere Shutdown-/Restore-Reihenfolge und Schutz gebundener Orchestrierungen,
|
||||
- WMI-Auflösung über breite Abfrage mit clientseitigem Filter,
|
||||
- atomare JSON-Ersetzung auf demselben Volume,
|
||||
- Neutralisierung formelartiger CSV-Werte,
|
||||
- Persistenz eines Operationsplans vor der Benutzerbestätigung,
|
||||
- Staging-, Aktivierungs-, Quarantäne- und Rollbackgrenzen des Installers,
|
||||
- begrenzte Self-Test-Prozess- und Streambehandlung.
|
||||
|
||||
Selbsterklärende Zuweisungen und reine UI-Konstruktion werden nicht zeilenweise kommentiert. Kommentare sollen die fachliche Begründung, Sicherheitsgrenze oder Plattformbesonderheit festhalten und nicht lediglich den unmittelbar sichtbaren Code wiederholen.
|
||||
|
||||
## UI Workflow
|
||||
|
||||
1. Anwendung mit Administratorrechten starten.
|
||||
|
||||
Reference in New Issue
Block a user