Du bist nicht angemeldet.

Stilllegung des Forums
Das Forum wurde am 05.06.2023 nach über 20 Jahren stillgelegt (weitere Informationen und ein kleiner Rückblick).
Registrierungen, Anmeldungen und Postings sind nicht mehr möglich. Öffentliche Inhalte sind weiterhin zugänglich.
Das Team von spieleprogrammierer.de bedankt sich bei der Community für die vielen schönen Jahre.
Wenn du eine deutschsprachige Spieleentwickler-Community suchst, schau doch mal im Discord und auf ZFX vorbei!

[C#/VB.NET]Xml-Kommentare?

Werbeanzeige

C--

Alter Hase

  • »C--« ist der Autor dieses Themas

Beiträge: 465

Beruf: Schüler

  • Private Nachricht senden

1

29.08.2009, 18:50

[C#/VB.NET]Xml-Kommentare?

Welche Kommentarform findet ihr besser?

Insgesamt 9 Stimmen

11%

Xml-Kommentar (1)

89%

"Normaler Kommentar" (8)

Hallo Leute, ich habe neulich von den Xml-Kommentaren in C# und VB.NET gehört, ich wollte mal eure Meinung hören, wie man seinen Quellcode kommentieren sollte, Normaler Kommentar(sprich: in C# // und VB.NET ' / REM) oder XML-Kommentar. Welche Vorteile/NAchteile seht ihr in XML-Kommentaren?
Ich spreche: C/C++, C++/CLI C#, VBA, VB.NET, Delphi, (HTML, Javascript(bisschen))
------------------------------------------------------------
Hier steht eventuell schon in ein paar Monaten der Link zu meiner Homepage!

return 0;
;)

Gotbread

Alter Hase

Beiträge: 421

Beruf: Student (Etechnik) + Hiwi

  • Private Nachricht senden

2

29.08.2009, 19:43

mehr zu tippen. bei einem // kommentar muss ich nur 2mal die selbe taste
drücken. das ist fast nichts.
Mfg Goti
www.gotbread.bplaced.net
viele tolle spiele kostenlos, viele hardware-basteleien :)

"Es ist nicht undicht, es läuft über" - Homer Simpson

GR-PA

Treue Seele

Beiträge: 326

Wohnort: Daheim

Beruf: Faulenzer

  • Private Nachricht senden

3

29.08.2009, 19:58

Ich habe das Gefühl, dass ihr nicht genau wisst, was XML-Kommentare in C# sind...
Einmal googlen->http://www.aspheute.com/artikel/20020730.htm
Hier werden XML-Kommentare in C# und deren Vorteile erläutert.
Der zusätzliche Aufwand lohnt sich aber erst bei größeren Projekten. Außerdem sind diese Kommentare kein Ersatz für gewöhnliche Kommentare, da durch ihre Verwendung zwar eine gute Dokumentation aber ein schlechter lesbarer Quellcode erreicht wird. Meiner Meinung nach sollte man, wenn man denkt, dass sich die Verwendung von XML-Kommentaren lohnt, beide "Arten" von Kommentaren verwenden.
Signaturen werden überbewertet

xardias

Community-Fossil

Beiträge: 2 731

Wohnort: Santa Clara, CA

Beruf: Software Engineer

  • Private Nachricht senden

4

29.08.2009, 20:00

XML Kommentare haben den Vorteil, dass du mit entsprechenden Tools automatisch eine Dokumentation aus den Kommentaren generieren kannst.

z.B. über NDoc http://ndoc.sourceforge.net/

Jonathan_Klein

Community-Fossil

Beiträge: 3 820

  • Private Nachricht senden

5

29.08.2009, 21:27

Ich kenne die nicht wirklich, aber auf der Seite da sehen die echt nach enorm viel Getippe aus.
Da kann ich auch einfach Doxygen für die Dokumentation nehmen, da sind die einzelnen Steuertexte wesentlich kürzer und wenn ich das möchte kann ich trotzdem HTML einbauen.
Außerdem kann man die immer noch sehr gut lesen, was bei dem XML Kram nicht unbedingt der Fall zu sein scheint.
Lieber dumm fragen, als dumm bleiben!

C--

Alter Hase

  • »C--« ist der Autor dieses Themas

Beiträge: 465

Beruf: Schüler

  • Private Nachricht senden

6

29.08.2009, 21:54

Ich glaube, man kann es such ziemlich gut mit den xmlkommentaren übertreiben: sowas geht auch: :lol: :lol: :lol:

Quellcode

 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

 /// <summary>
    /// blub enum
    /// </summary>
    enum blub
    {
        /// <summary>
        /// das ist a
        /// </summary>
        A = 0x121657486,
        /// <summary>
        /// das ist b
        /// </summary>
        B = 0x047846664

    }


aber soo viel Tipparbeit ist das gar nicht VC# erzeugt die drei / und die Tags, auch Parameter bei Funktionen. :D

Man kann das ja bei Klassen/structs/enums zur erklärung machen, aber nicht überall.
Ich spreche: C/C++, C++/CLI C#, VBA, VB.NET, Delphi, (HTML, Javascript(bisschen))
------------------------------------------------------------
Hier steht eventuell schon in ein paar Monaten der Link zu meiner Homepage!

return 0;
;)

xardias

Community-Fossil

Beiträge: 2 731

Wohnort: Santa Clara, CA

Beruf: Software Engineer

  • Private Nachricht senden

7

29.08.2009, 22:28

Das hat aber nix mit XML Kommentaren zu tun, sondern mit Kommentaren allgemein.

Regel Nummer 1 bei Kommentaren: Sinnvolle Kommentare machen. Das was im Code steht im Kommentar zu wiederholen ist nicht sinnvoll ;)

C--

Alter Hase

  • »C--« ist der Autor dieses Themas

Beiträge: 465

Beruf: Schüler

  • Private Nachricht senden

8

29.08.2009, 22:45

Das war ja nur ein schwachsinniges Besipiel :roll:
Ich spreche: C/C++, C++/CLI C#, VBA, VB.NET, Delphi, (HTML, Javascript(bisschen))
------------------------------------------------------------
Hier steht eventuell schon in ein paar Monaten der Link zu meiner Homepage!

return 0;
;)

Werbeanzeige