Was ist mit der Beschreibung von Classen/Interfaces/...?

Allgemeine Fragen und Antworten zur Entwicklungsumgebung für die DotNetLib-Projekte und deren Aufbau.
Fragen speziell zum Code eines Projektes u. ä. bitte im jeweiligen Projekt-Forum stellen.

Was ist mit der Beschreibung von Classen/Interfaces/...?

Beitragvon Josef Pötzl » Fr 23. Mär 2012, 10:19

Was ist mit der Beschreibung von Classen / Interfaces / Methoden etc. mit:
Code: Alles auswählen
        /// <summary>
        ///  
        /// </summary>
Josef Pötzl
Moderator
 
Beiträge: 764
Registriert: Mo 30. Nov 2009, 10:08
Wohnort: Klagenfurt
Accessversion: 2010 (2013)

Re: Was ist mit der Beschreibung von Classen/Interfaces/...?

Beitragvon Josef Pötzl » Fr 23. Mär 2012, 10:20

Das kann genutzt werden. Diese Einträge werden später mit Doxygen ausgewertet, um eine Projekt-Dokumentation zu erstellen.
Beispiel: SqlTools
Josef Pötzl
Moderator
 
Beiträge: 764
Registriert: Mo 30. Nov 2009, 10:08
Wohnort: Klagenfurt
Accessversion: 2010 (2013)

Re: Was ist mit der Beschreibung von Classen/Interfaces/...?

Beitragvon FireWalkerHH » Fr 23. Mär 2012, 10:27

Uns, soweit ich weiß, werden diese Summary-Kommentare auch vom VisualStudio ausgewertet und in ToolTips angezeigt.
Thomas Franzek

Diese Signatur wurde mit 100% chlorfrei gebleichten, glücklichen Elektronen erzeugt.
Diese entstammen keiner Lagerelektronenhaltung und werden nicht zu ihrer Arbeit gezwungen
FireWalkerHH
Entwickler
 
Beiträge: 57
Registriert: Mo 18. Okt 2010, 12:13

Re: Was ist mit der Beschreibung von Classen/Interfaces/...?

Beitragvon KGunder » Fr 23. Mär 2012, 12:19

D.h. es ist ok, wenn ich mal versuche zu allen vorhandenen Klassen / Procedure etc halbwegs sinnvolle Beschreibungen einzutragen?
KGunder
Entwickler
 
Beiträge: 48
Registriert: Mo 27. Sep 2010, 11:20

Re: Was ist mit der Beschreibung von Classen/Interfaces/...?

Beitragvon Josef Pötzl » Fr 23. Mär 2012, 12:23

Das ist nicht nur ok, sondern wäre super. :)
... allerdings würde ich das nur bei öffentlichen Methoden empfehlen. Wenn man auch private Methoden so beschreibt, laufen wir Gefahr, dass die Beschreibung und die Aufgabe der Methode nach Überarbeitungen nicht mehr zusammenpassen. => In so einem Fall finde ich es besser, wenn man der Methode einen besseren Namen gibt, falls die Aufgabe nicht gut genug erkennbar ist.
Das gilt übrigens auch die die Namen der Klassen und Methoden. Falls jemand ein besserer Name einfällt, der die Aufgabe besser beschreibt ... nur keine Angst vor Änderungen.

Anm.: Ich werde dann demnächst auch noch versuchen die doxygen-Doku-Erzeugung so zu gestalten, dass die Doku automatisch erstellt wird. (Derzeit muss ich die html-Dateien noch manuell hochladen.)

Noch etwas:
Doxygen würde eine mehrsprachige Dokumentation erlauben.
Josef Pötzl
Moderator
 
Beiträge: 764
Registriert: Mo 30. Nov 2009, 10:08
Wohnort: Klagenfurt
Accessversion: 2010 (2013)


Zurück zu FAQ

cron