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

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?

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?

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.

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.

Code ist zum Lesen gedacht ... oft.

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

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 ;)

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)

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.

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.

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.

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.

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 ...