Unter dem Begriff "Code Documentation Practice" verstehe ich das Vorgehen bei der Dokumentation von Software im Sinne der Prinzipien der "GDP - Good Documentation Practice".
Eine Zusammenfassung als EBook kann auch käuflich erworben werden.
Dez 04 2019
Zu diesem Thema ist natürlich schon viel geschrieben worden, daher will ich mich hier auf das Wesentliche beschränken und ein paar Tipps für die Praxis geben. Zum Einen stellt ihr euch sicher die Frage, wieso ich die Quellcodeverwaltung zum Thema “Dokumentation” hinzu rechne. Um es kurz zu machen: Wer sagt denn, dass Dokumentation nur für …
Nov 29 2019
Neben der guten Dokumentation des Codes gehört zu einem Programm auch, dass der Benutzer mit wenig Aufwand herausfinden kann, mit welcher Version er gerade arbeitet. Üblicherweise stellt der Entwickler ein Formular namens “About” oder im Deutschen “Über” zur Verfügung, das alle notwendigen Informationen auf einen Blick enthält.
Nov 25 2019
Bei der Dokumentation des Quelltextes kommt es entscheidend darauf an, dass sowohl der Entwickler diese lesen kann, als auch eine automatisierte Auswertung möglich ist. Daher müssen gewisse Formate eingehalten werden. Hier ist ein Vorschlag dazu.
Nov 22 2019
Dieser Artikel ist der Start einer Reihe von Empfehlungen für die Dokumentation von VBA-Code. Prinzipiell sind das alles keine völlig neuen Ideen. Ich habe das, was andere auch tun, nur etwas an die VBA-Welt angepasst.
Neueste Kommentare