Kommentare im Quelltext

[steinadler]

Hallo zusammen,

hab mal eine allgemeine Frage:

Was haltet ihr von Kommentaren im Quellcode und sollten diese in deutsch oder englisch sein.

Ich persönlich finde einen kommentierten Code besser, da ich mich darin besser zurechtfinde... da ja doch einige Anweisungen eine sehr verschleierte Bedeutung haben.

Euer Steinadler

[Artox]

Also grundsätzlich ja

mit der Sprache normal englisch damit sich auch nicht deutsch sprachige

zurechtfinden.

Wenn der Quelltext nur für dich ist reicht auch deutsch,

ich muss sagen schreibe meine kommentare nur deutsch

[steinadler]

Wenn der Quelltext nur für dich ist reicht auch deutsch,

ich muss sagen schreibe meine kommentare nur deutsch

Bei uns ist das auch so ähnlich.... so ein Mitschmatsch aus deutsch und englisch

[dennisderweber]

kommentare grundsätzlich.

sprache hängt von der zu erwartenden lesergruppe ab. mischmasch gibts da nicht.

[Guybrush Threepwood]

Wenn ich selber was für mich programmiere kommentiere ich da gar nichts, ist aber auch schon lange nicht mehr vorkommen das ich da was größeres gemacht hab.

Auf der Arbeit überwacht Visual Studio das alle öffentlichen Properties, Methoden usw. von Klassen kommentiert werden und schmeißt sonst ne Warnung aus

PS: Kommentiert wird bei uns auch alles in Englisch, was ich schon für Sinnvoll halte.

[steinadler]

Auf der Arbeit überwacht Visual Studio das alle öffentlichen Properties, Methoden usw. von Klassen kommentiert werden und schmeißt sonst ne Warnung aus

Wie kann man das denn einstellen??

[Guybrush Threepwood]

Indem du in den Projekteigenschaften die entsprechenden Code Analyseregeln definierst.

[TinTin]

Indem du in den Projekteigenschaften die entsprechenden Code Analyseregeln definierst.

Welches Studio? Und unter welchem Punkt in den Projekteigenschaften?

ciao TinTin

[Bubble]

Was haltet ihr von Kommentaren im Quellcode und sollten diese in deutsch oder englisch sein.

Kommentare sind sehr sinnvoll, gelegentlich unverzichtbar und oft zu wenig gebraucht.

Über die Sprache kann man diskutieren. Ich würde jedem die freie Wahl überlassen, solange es keine zwingenden Gründe für eine bestimmte Sprache gibt.

Vorgegebene Regeln, wie "alles in Sprache X", obwohl alle beteiligten Entwickler die Muttersprache Y sprechen, nur auf den Verdacht hin, dass irgendwann irgendwer, der nur X und kein Y spricht, die Kommentare und Bezeichner vielleicht lesen möchte, halte ich hingegen für ungeschickt, solange nicht alle Entwickler X sprechen (und schreiben) und die Sprache auch ausserhalb der Kommentarzeilen verwenden. Warum? Es reduziert die Effiziens und Produktivität. Wenn die Entwickler aber tatsächlich weltweit miteinander zusammenarbeiten und Code austauschen, dann ist es hingegen sinnvoll, eine gemeinsame Sprache auszuwählen.

[TinTin]

Indem du in den Projekteigenschaften die entsprechenden Code Analyseregeln definierst.

kann es sein, dass sich das nur auf die Team System Ausgabe bezieht?

[baba007]

Gott sei dank benutze ich eclipse und habe checkstyle on ich neige immer dazu nichts zu kommentieren

[Stupid Killer]

also muss mal sagen immoment Programiere ich nur für mich und die Schule, für mich keine Kommentare aber für die Schule müssen wir se machen aber zum glück auf deutsch

[The Nightfly]

Kommentare sind das wichtigste überhaupt. Bei uns wurde gestern darüber auch im Unterricht diskutiert.

Kommentare, ob in Deutsch oder Englisch, gehören in ein öknomisches Programm. Sie gehören genauso, wie eine Dokumentation oder eine Planung zur Softwareentwicklung.

Eine Firma, die nicht dokumentiert und ebenfalls Programmierer beschäftigt, die dass nicht so genau nehmen, können echt in Schwierigkeiten kommen. Denn wenn dieser Programmierer mal geht, kann sich ein Anderer nicht mal eben schnell in zig Zeilen Quellcode reinfuchsen. Was sagt man da einem Kunden?

Zumal ist es so auch recht praktisch, da man ja manchmal auch ein Jahr später nochmal am Quelltext arbeiten muss und da bieten die Kommentare Anhaltspunkte. Wer weiß auch schon immer genau, was man vor einem Jahr so genau programmiert hat.

[Jaraz]

Auf der Arbeit überwacht Visual Studio das alle öffentlichen Properties, Methoden usw. von Klassen kommentiert werden und schmeißt sonst ne Warnung aus

Kommentare machen nur da Sinn, wo es auch was zu kommentieren gibt.

Ich halte es grundsätzlich so, dass ich verständliche Bezeichnungen wähle.

	public void addSupportRequest(SupportRequest supportRequest) {

		supportRequest.setReceiver(this);

		if (supportRequestSet == null) {

			supportRequestSet = new HashSet<SupportRequest>();

		}

		supportRequestSet.add(supportRequest);

	}

Da brauche ich erstmal nix kommentieren.

Wenn komplizierte Abläufe innerhalb der Methode ablaufen die nicht sofort ersichtlich sind, dann wird kommentiert.

Ganz schlimm finde ich, mit unsinnigen Kommentaren aufgeblähten Code.

Generell programmiere ich Englisch. Nur bei komplizierten Wörtern rutscht auch mal Deutsch rein.

Gruß Jaraz

[Guybrush Threepwood]

Kommentare machen nur da Sinn, wo es auch was zu kommentieren gibt.

Ich halte es grundsätzlich so, dass ich verständliche Bezeichnungen wähle.

	public void addSupportRequest(SupportRequest supportRequest) {

		supportRequest.setReceiver(this);

		if (supportRequestSet == null) {

			supportRequestSet = new HashSet<SupportRequest>();

		}

		supportRequestSet.add(supportRequest);

	}

Da brauche ich erstmal nix kommentieren.

Wo ist das Problem da kurz drüber zu schreiben was die Funktion macht und was zu den Parametern zu sagen? Klar kann man sich das Anhand der Namensgebung denken. Aber wenn du es vernünftig kommentierst dann hast du es wenigstens auch vernünftig im Visual Studio Intellisense drin stehen.

Ich meine klar wenn du mit einer anderen IDE arbeitest wo du die Kommentare nur siehst wenn du in den Quellcode der Klasse schaust dann bringt das auch nicht so viel da was zu Kommentieren, denn man schaut sich die Funktion ja dann eh an wenn man sich für sie interessiert.

Wenn du die Klasse aber jetzt nur benutzt und den Quellcode nicht hast, oder nicht sehen möchtest dann ist es schon praktisch wenn du beim Aufrufen der Funktion kurz ne Erklärung dazu hast.

Ich weiß nicht wer hier mit Visual Studio arbeitet, aber das bietet halt schon fertige Formate zum Kommentieren an die automatisch erzeugt werden wenn man 3 Slashes eingibt. Du musst dann nur noch deinen Text dahinter setzen und wenn du ein Tool wie GhostDoc verwendest erzeugt dir das auch schon einen Kommentartext anhand deiner Namensgebung

Wenn du dann später die Klasse in einem anderem Programm (zum Beispiel über eine Dll oder Assembly) verwendest und einen Punkt hinter den Variablennamen machst so dass das Intellisense Fenster mit allen öffentlichen Methoden und Properties aufgeht dann erscheint zum aktuell gewähltem Punkt ein Tooltipp wo dein Kommentar schön aufgeführt ist.

Das ist sehr schön und praktisch gelöst.

[Tobias2k6]

aber bitte sinnvoll kommentieren, ein diktat will keiner lesen und ist auch nicht im sinne der funktion eines kommentars.

stichwortartig oder kurze knackige verständliche sätze.

gute kommentare schreiben ist fast genauso schwer wie gut zu coden