Einzelnen Beitrag anzeigen

Benutzerbild von Bernhard Geyer
Bernhard Geyer

Registriert seit: 13. Aug 2002
17.196 Beiträge
 
Delphi 10.4 Sydney
 
#14

AW: Eure favorisierte Form der Dokumentation

  Alt 12. Jul 2015, 09:54
Wikis haben Erfahrungsgemäß das Problem, dass sie schnell veralten. Kaum jemand denkt im Regelfall daran, wenn er etwas im Code ändert, das auch im Wiki nachzupflegen.
Wenn Sinnvollerweise im Quellcode (Stichwort JavaDoc und Co. ) kommentiert wreden kann, wird in 2015 (fast) keiner mehr das in einem (immer veralteten) extra Dokument machen.

Ich persönlich bin ein Fan von guter Code-Dokumentation, bei der man auch konzeptionelle Doku zu Architektur und abläufen in der Solution als Einzelfiles mit eincheckt und dort mit pflegt.
Hier wirds dann aber schwieriger wenn man z.B. ein Solution als Library für andere Anwendung hat. Dann muss man bei den anderen Anwendungen welche diese Library verwenden wo dort wieder die Doku liegt. Und Hyperlinks zwischen der Dokumentation der Anwendungen und der Library sind auch schwer möglich.


Wir sind aber ja auch eine .NET Schmiede, und ich weiss nicht ob das auch mit Delphi tut.
Lösungen gibts auch für Delpi. Evtl. nicht so umfangreich.
Windows Vista - Eine neue Erfahrung in Fehlern.
  Mit Zitat antworten Zitat