Auszeichnungssprachen für Dokumentationen 15.06.2017, 00:00 Uhr

Stenographie für Entwickler

Beim Dokumentieren hilft leider kein IntelliSense. Auszeichnungssprachen springen in diese Lücke.
(Quelle: shutterstock.com/Thinglass)
Über die Notwendigkeit von Dokumentationen in der Entwicklung muss man nicht mehr viele Worte verlieren, sie ist klar ersichtlich: Die Architektur ist schriftlich niederzulegen und mit aussagekräftigen Grafiken anzureichern. Quelltext ist zu kommentieren, und auch sonst ist auf jeden Fall die eine oder andere Entwurfs- und Codierungsentscheidung zu begründen.
Reißt hier der Schlendrian ein, so rächt es sich, und man darf nur hoffen, dass man später für das Projekt nicht mehr zuständig ist und es einen Kollegen trifft, sich mühevoll in den vorliegenden Quellcode einzuarbeiten. Man selbst kann von Glück sagen, wenn man dann möglichst weit weg ist.

Diesen Artikel lesen Sie exklusiv als dotnetproPlus Abonnent

Sie wollen zukünftig auch von den Vorteilen eines plus-Abos profitieren? Werden Sie jetzt dotnetpro-plus-Kunde
  • 2 Monate Gratis testen
  • Über 4.000 qualifizierte Fachartikel
  • Auf jedem Gerät verfügbar