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.
Jan 03 2022
Ich bin da ja echt in einem Zwiespalt: Einerseits bin ich ein Fan von Büchern, aber für gewisse Sachen scheint es mir eher sinnlos zu sein, Holz zu verbrauchen. Auch wenn Holz im Wortsinne ein “nachwachsender Rohstoff” ist, wächst ein Baum doch erheblich langsamer als er dann verbraucht wird – egal ob “Verbrauch” nun “Verbrennen” bedeutet oder “zu Papier verarbeiten”.
Aug 26 2020
Wenn mir eine Fehlermeldung übermittelt wird, möchte ich so viele Informationen bekommen, wie möglich. Neben Informationen darüber, was der Anwender gerade gemacht hat, sollte dies auch den “Call Stack” enthalten, aus dem die aufgerufene Funktion eindeutig hervor geht.
Aug 12 2020
In meiner kurzen Reihe über Code Documentation Practice habe ich bereits erwähnt, dass ein Programm eine Versionsnummer haben sollte, und dass diese dem Anwender in einer übersichtlichen und vor allem leicht zu findenen Weise präsentiert werden sollte, z.B. in einem About-Screen. Nun will ich dieses Konzept noch etwas erweitern.
Dez 12 2019
Wenn wir, wie bereits beschrieben, die Dokumentation des Quellcodes auf die immer gleiche Weise machen wollen, was liegt da näher, als ein Template dafür zu verwenden? Dafür sind die MZ-Tools bestens geeignet.
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 …
Neueste Kommentare