Ist „lustiges Kommentieren“ eine schlechte Übung oder nicht? [geschlossen]

37

Ich möchte Sie fragen, ob das Hinzufügen von "Ostereiern" in der Quelldokumentation unprofessionell ist oder nicht. Wahrscheinlich haben Sie die lesen Stackoverflow Umfrage für lustige Kommentare in einer Quelle Dokumentation, und ich habe stolperte persönlich an viele solcher Dinge , die während meiner Arbeit, auch lustig (oder nicht) Material in den öffentlichen API - Dokumentation (zum Beispiel dieses schwache BZZZTT !! 1! Sache In der öffentlichen Android-Dokumentation kann ich mindestens ein Dutzend weitere Beispiele nennen.

Ich kann mir keine endgültige Meinung bilden, weil ich selbst widersprüchliche Argumente habe.

Pro Argument:

  • Es kann jemanden aufheitern und seinen / ihren Tag lustiger / produktiver machen. Ein Großteil des Quellcodes muss ohnehin nicht kommentiert werden (wenn das Projekt ordnungsgemäß ausgeführt wird), da die spezifische Methode (zum Beispiel) selbsterklärend ist oder wenn es sich um einen Haufen seltsamen beschissenen Codes handelt, kann sie dies nicht auf sinnvolle Weise erklärt werden, damit ein lustiger Witz die möglichen Informationen, die Sie aus dem Dokument erhalten können, nicht beeinträchtigt.

Contra Argument:

  • Wenn Sie sehr konzentriert / frustriert sind, ist das Letzte, was Sie brauchen, ein dummer Scherz von jemandem. Anstatt Ihnen die Informationen zu geben, die Sie über den dokumentierten Codeabschnitt benötigen, kann dies Sie nur noch frustrierter machen. Und die Vorstellung, wie die Dokumentation aussehen würde, wenn alle damit anfangen, ist schrecklich. Außerdem ist der Typ, der den Witz schreibt, möglicherweise der einzige, der denkt, dass es lustig / interessant / wert ist, Zeit zum Lesen zu verschwenden.

Was denkst du?

jemandem
quelle
Bitte lesen Sie die FAQ und Richtlinien der Site, um Fragen zu stellen. Diese Frage entspricht wirklich nicht diesen Richtlinien.
Walter
8
@Walter: Es ist so ziemlich die gleiche Frage wie programmers.stackexchange.com/questions/50928/… , aber für witzige Kommentare anstelle von profanen Kommentaren, und die verknüpfte Frage ist nicht geschlossen, wurde vor einem Monat gestellt. Ich werde keine Zeit damit verschwenden, mit Ihnen darüber zu streiten, dass diese Frage den häufig gestellten Fragen (FAQ) entspricht und mit den besten (guten) Praktiken beim Schreiben von Code zusammenhängt.
Jemand
2
7 Stimmen, dieses Q ist eindeutig erwünscht. Persönlich bin ich nicht sauer, weil ich von dem "Betrug", den Sie schon oft erwähnt haben, aber ich kann die Argumente für "Pro" sehen, also bin ich gespannt, was das Ergebnis ist. (Das Schlimmste, dem ich übrigens begegnet bin, war ein Programmierer, der dachte, ein "komisches" Foto einer BB-Waffe, die auf ein Kätzchen mit den Pfoten zeigt, muss auf der Homepage aller unserer Entwickler-Server zu finden sein. Seufz ...)
James
@sombody - Sie haben Recht, aber witzige Kommentare können Sie nicht so schnell entlassen oder sogar noch schlimmer machen, wenn Sie belästigt werden. Ich werde in Betracht ziehen, die andere Frage zu schließen (Ich bin mir nicht sicher, ob ich das Recht hatte, als es veröffentlicht wurde.).
JeffO
1
Ich bin damit einverstanden, dass dieser Beitrag wieder geöffnet wird, obwohl ich nicht abstimmen kann, weil ich nicht den Repräsentanten habe. Der Sinn, Programmierer von SO zu trennen, liegt in solchen Fragen. Plus mit 22 Stimmen für diese Frage ist es eindeutig von der Community gewollt.
RoboShop

Antworten:

12

Ich denke, dass lustige Kommentare Zeit verschwenden - verschwendete Zeit zum Schreiben, verschwendete Zeit zum Lesen, verschwendete Zeit, um Ihren Kollegen die lustige Bemerkung zu zeigen, die (fast immer) nur rätselhaft ist und so weiter.

Aber ... niemand arbeitet tatsächlich jeden Tag zu 100% (Sites wie diese wären leer, wenn wir das tun würden) und echter Humor unterbricht den Tag und hilft dabei, die Moral aufrechtzuerhalten.

Ich würde immer noch dagegen stimmen, nur weil jeder 'lustige' Kommentar, den ich jemals gelesen habe, zu der Zeit sehr lustig gewesen sein mag - aber ich habe noch keinen gesehen, der wirklich lustig ist, die meisten sind nur rätselhaft oder tief im Inneren -Scherz.

Wenn lustige Kommentare wirklich lustig wären, würde das meine Meinung ändern. Aber wenn Sie einmal zu Witzen ermutigt haben, ermutigen Sie dann zu Fluchen, Beleidigungen oder Böswilligkeit?

amelvin
quelle
5
+1 Sie lesen diese Kommentare nur, wenn Sie etwas korrigieren müssen und sie machen dann keinen Sinn und wenn Sie Fehler beheben, sind Sie sicherlich nicht in der Stimmung, einen „cleveren Witz“ eines anderen Entwicklers zu diesem Thema zu sehen. Anstatt über einen Witz nachzudenken, wenden Sie sich bitte etwas Zeit für klareren Code auf, beheben Sie einen Fehler usw. Und was passiert mit dem Witz, wenn etwas überarbeitet wurde?
22.
2
Es ist also wie Humor im Fleischraum: Es ist besser, lustig zu sein und es ist besser, nicht ALLES zu sein, was du tust.
Dan Ray
1
+1 klug, solange es nicht schadet. Es stop() //hammertimeist nicht lustig, bei jedem Stopp zu spielen.
Glasnt
@glasnt - das ist ein wirklich lustiger Kommentar - würde aber bei Iteration 2 irritieren und anschließend zunehmend irritieren!
Amelvin
Das Zulassen von Humor in Kommentaren ist durchaus akzeptabel. Warum eine ohnehin schon trockene Industrie trocken UND humorlos machen? Das Zulassen von Fluchen, Beleidigungen oder Böswilligkeit ist eine ganz andere Sache. Meine Erfahrung war völlig anders als deine. Ich habe einige Male gekichert, als ich informative Kommentare las, die einen witzigen Sinn für Humor zeigten. Es hat meinen Tag besser gemacht. Man braucht etwas Intelligenz, um einen geschmackvollen Humor zu haben, aber wenn es mit Reife gemacht werden kann, bringen Sie es auf.
JBeck
71

Ich bin ein großer Fan von lustigen Kommentaren .

Sie sollten in Ihren Kommentaren immer professionell sein, aber ein bisschen Humor wird den Leser nicht umbringen.

Vor allem, wenn der Leser Mitglied Ihres Teams ist.

Was ich am wenigsten mag, sind Entwickler, die sich selbst zu ernst nehmen. Ich denke, wir sollten Spaß an der Arbeit haben, oder Arbeit ist es nicht wert.


quelle
9
+1 Für "Professional but Funny"
Deworde
Das Programmieren macht selbst Spaß :)
Gopi
2
@ Sri Kumar: Leider nicht immer. :(
Bobby
1
@Bobby: entscheide dich, es dann lustig zu machen! Wenn sie dich nicht lassen, bring dein Glück zu einem Unternehmen, das es verdient.
3
+1 dafür, dass du dich nicht zu ernst nimmst.
JeffO
8

Wenn es eine Bedeutung hat, ist es in Ordnung, lustig zu sein. Es ist in Ordnung, etwas in einem Kommentar auf amüsante Weise zu erklären. Wenn es jedoch nur etwas Lustiges ist und keinen tatsächlichen Wert als Kommentar enthält, ist das nur ärgerlich. Denken Sie immer daran, dass der Grund für Kommentare darin besteht, die Wartung effizienter zu gestalten. Humor muss nicht im Widerspruch dazu stehen, könnte aber nicht richtig gemacht werden.

Brian Knoblauch
quelle
Der Fehlerbehandlungscode eines kritischen Programms enthält einen Kommentar: "Das Leben ist ein _ und dann stirbst du." am ende der erklärung. Es ist lustig und macht Sinn.
Michael K
1
@Michael - Das ist ein perfektes Beispiel dafür, was ich für eine Verschwendung halte. Es ist nicht lustig (eine Wiederholung einer sehr alten und müden Aussage) und bringt nichts von Wert.
Brian Knoblauch
8

Code ist zum Lesen gedacht ... oft.

Wie viele Witze kennen Sie, die nach dem hundertsten Erzählen lustig sind?


quelle
@ Thorbjørn Ravn Andersen: Was ist mit Dilbert-Cartoons, die Sie drucken und an Ihrer Schrankwand anheften? ;)
@Pierre, wenn du einen einzelnen Dilbert findest, der zum Einfügen eines Quellcode-Kommentars geeignet ist, lass es mich bitte wissen.
@ Thorbjørn Ravn Andersen: nicht Dilbert, aber dieser hat den Platz verdient: i.imgur.com/tu7Fd.jpg
@Pierre, eigentlich halte ich den Wortlaut in diesem Poster für übertrieben und nicht lustig, aber das ist eine andere Sache. Wie viele hast du noch?
@ Thorbjørn Ravn Andersen: das ist der einzige
7

Lustige Kommentare sind toll.

  • Es gibt Ihrem scheinbar langweiligen Code eine positive Atmosphäre.
  • Wenn du dein Timing richtig verstehst. Es ist viel besser zu erklären als ein normaler, langweiliger Kommentar. Mit "Timing" meine ich hier die Relevanz für den Code unter dem Kommentar.
  • Ihr Code wird vielen in Erinnerung bleiben, weil Emotionen einen besseren Platz im (menschlichen) Gedächtnis bekommen. Dies ist ein großartiger Trick, wenn Sie möchten, dass mehr Leute mit Ihnen an einem Open-Source-Projekt arbeiten.
  • Generell hilfreich in Bewertungen. Es macht Ihren Code viel erträglicher. Natürlich sollten Sie sich zuerst darauf konzentrieren, guten Code zu schreiben. Ich habe das Gefühl, wenn man mit dem Code, den sie schreiben, vertraut ist, sind lustige Kommentare nur ein Nebeneffekt.

Sei einfach nicht lustig wie dieser Typ ;)

Reno
quelle
6

Hier ist eine, die ich um zwei Uhr morgens schrieb ("DQ" sind die Initialen meiner Firma):

// Twas the night before go-live and all through DQ
// the devs were all crying and yes, this means you.
// Keys had been saved with both hyphens and 'scores
// which left this programmer with finger pad sores.
// The solution I crafted, you'll likely find lacking:
// to OR them together with judicuous hacking.

$hyphenated = str_replace('_','-',$data_type_key);
$underscored = str_replace('-','_',$data_type_key);
// (and then see line 46)
Dan Ray
quelle
3
Ja, solche Dinge treten am wahrscheinlichsten um 2 Uhr morgens auf, aber ich halte das nicht für einen guten Witz - jemand nach Ihnen muss 6 Textzeilen lesen, wenn er den Kommentar für 2 Quelltextzeilen sehen möchte. Das gleiche Verhältnis wie 600 Zeilen Aufsatz lesen zu müssen, der 200 Zeilen Code erklärt
jemand, der am
5
Oh, Effizienz war aus dem Fenster. Dieses Projekt war schon so ein Haufen - weißt du -, ein bisschen Leichtsinn trug viel zur Moral von 2 Uhr morgens bei. Wenn Sie bemerken, soll der Code, den ich hier schreibe, die Schlamperei eines anderen umgehen, um die es in den letzten zwei Wochen des Todesmarsches eigentlich ging. Ich dulde so etwas nicht als normale Praxis, aber ich gebe zu, dass ich mit dieser ziemlich zufrieden war.
Dan Ray
In dieser Situation würde ich mich auch sehr freuen
jemand
Geben Sie keine Zeilennummern ein, sondern verwenden Sie "Suche nach <was auch immer>", wobei <was auch immer> selbst ein Kommentar ist.
Vinko Vrsalovic
3

Wenn Sie Ihren Quellcode vor dem Kunden überprüfen würden, wäre es Ihnen peinlich?

Keine der aktuellen Antworten scheint dies zu berücksichtigen. Einige Kunden haben keinen Sinn für Humor und nehmen die Witze als Zeichen dafür, dass Sie Ihren Job nicht ernst nehmen. Sie werden daraus schließen, dass Sie mit Ihrer Arbeit nachlässig sind.

Lustige Codekommentare können manchmal unprofessionell und unangemessen sein.

M. Dudley
quelle
3

Abgesehen von dem, was bereits gesagt wurde, verstehen einige Ihrer Kollegen aus Übersee möglicherweise nicht, wenn Sie in einem internationalen Team arbeiten. Dies liegt entweder an lokalen kulturellen Referenzen oder am Wortspiel, das von jemandem, für den Englisch keine Muttersprache ist, nicht verstanden wird . Gleiches gilt für Open Source-Projekte.

vartec
quelle
2

Wenn es effizient ist und nicht die Zeit der Leser verschwendet (sowohl beim Lesen als auch beim Verstehen), sehe ich kein Problem mit ein bisschen Humor.

jonners99
quelle
2

Genau wie Witze in der realen Welt ist es nicht lustig, nicht produktiv und nicht professionell, wenn man sie die ganze Zeit macht. Aber es gibt eine Zeit und einen Ort für alle Witze, und es gibt eine Zeit und einen Ort im Code. Genau wie in der realen Welt ist es wichtig zu wissen, wo, wann und wie man den Witz macht.

James Bedford
quelle
1

Hängt davon ab, für Hausaufgaben am College habe ich fast immer lustige Kommentare gemacht, da ich wusste, dass es niemals verwendet wird und nur eine Hausaufgabe ist.

Für ernstere Projekte würde ich sie immer noch hier und da verwenden, aber nicht so häufig, so dass es ärgerlich oder schwer zu verstehen ist und dem Zweck des Kommentars widerspricht.

Ich erinnere mich an ein bisschen Webprogrammierung, bei der ich Browser-Inkompatibilitäten und seltsamen Störungen ausweichen musste. Es endete manchmal in Kommentaren voller Wut und Hass in den .jsAkten.

Meine Grundregel lautet: Wenn etwas klar ist, was der Codeabschnitt bewirkt, schalten Sie die Funktion LUSTIGE KOMMENTARE EIN!

Wenn der Code so undurchsichtig und verdunkelbar ist (wie die " Inline-Klasse "), verwende ich lieber Kommentare, die ich in ein paar Tagen selbst verstehe ...

Polemon
quelle