Sie sind aktuell nicht angemeldet.

Funktionen: Einloggen  |  Neu registrieren  |  Suchen

Re: Code beschreibung
Autor: Ralf Ehlert (Moderator)
Datum: 27.06.09 13:20
Einen Standard dafür kenne ich jetzt nicht, aber es gibt zwei "Kategorien" von Dokumentation: a) Code-Dokumentation b) Architektur-/Design-Dokumentation Bei a) kommentierst du direkt deinen Programmcode, z.B. mittels den XML-Kommentare ('''), um die einzelnen Codebestandteile zu dokumentieren. Aus den XML-Kommentare kannst du dann auch eine Referenz à la MSDN bauen. Bei b) hingegen dokumentierst du die Bestandteile deiner Anwendung (Komponenten) und wie diese zusammenarbeiten. Dabei gehst du auf die technische Implementierung nicht ein. Denn diese Dokumentation richtet sich auch an Nicht-Entwickler. Gerade letzteres ist Sache, wie das vereinbart wurde. Da gibt es verschiedene Extreme - von alles dokumentiert bis ins letzte Detail bis gar nicht. Ralf

Code beschreibung	955	Knetschi	27.06.09 12:58
Re: Code beschreibung	651	Ralf Ehlert	27.06.09 13:20
Nachtrag	781	Ralf Ehlert	27.06.09 13:22
Re: Nachtrag	614	Knetschi	27.06.09 13:56

Sie sind nicht angemeldet! Um auf diesen Beitrag zu antworten oder neue Beiträge schreiben zu können, müssen Sie sich zunächst anmelden. Einloggen  |  Neu registrieren

Funktionen:  Zum Thema  |  Gesamtübersicht

Suchen