Wie werden Kommentare generell in Programmiersprachen und Markups behandelt? Ich schreibe einen Parser für eine benutzerdefinierte Auszeichnungssprache und möchte dem Prinzip der geringsten Überraschung folgen , also versuche ich, die allgemeine Konvention zu bestimmen. Soll beispielsweise ein in...
Ich habe dies in der SO-Taverne gefragt gesehen , also poste ich die Frage hier. Ich fand es eine interessante Frage. (Natürlich gehört es nicht zu SO, aber ich denke es ist in Ordnung hier.) Fügen Sie in Ihren Codekommentaren Punkte (oder, wie das OP schrieb, "Punkte") hinzu? Warum , damit es...
Gibt es eine definitive Anleitung zum Schreiben von Code-Kommentaren für angehende Entwickler? Im Idealfall geht es darum, wann Kommentare verwendet werden sollten (und welche nicht) und welche Kommentare enthalten sollten. Diese Antwort : Kommentieren Sie nicht, WAS Sie tun, sondern WARUM Sie es...
Ich möchte von Ihnen alle Ratschläge und Erfahrungen zum Schreiben von Kommentaren in Ihren Code hören. Wie schreibt man sie am einfachsten und informativsten? Welche Angewohnheiten haben Sie beim Kommentieren von Codeteilen? Vielleicht ein paar exotische Empfehlungen? Ich hoffe, dass diese Frage...
Ich fange gerade erst mit der funktionalen Programmierung an und frage mich, wie ich meinen Code richtig kommentieren kann. Es erscheint ein wenig überflüssig, eine kurze Funktion zu kommentieren, da die Namen und Unterschriften bereits alles enthalten sollten, was Sie wissen müssen. Das...
Es erscheint nicht nur in einer Sprache, dass Kommentare nicht verschachtelt werden können. Haben Sie eine gute Lösung für dieses Problem? Eine Problemumgehung in C / C ++ und Java besteht darin, nur den einzeiligen Kommentar zu verwenden. In diesem Fall ist es jedoch unmöglich, einen größeren...
Verschlossen . Diese Frage ist gesperrt, da es viele Kommentare außerhalb des Themas gab. Derzeit werden keine neuen Antworten oder Interaktionen akzeptiert. Ich habe gesucht, aber nicht gefunden, wonach ich gesucht habe. Bitte verlinken Sie mich, wenn diese Frage
Immer wenn ich feststelle, dass ein großer Teil meines Codes geändert werden muss, entweder weil er falsch ist oder weil er an wichtige architektonische Änderungen angepasst werden muss, die aus anderen Gründen erforderlich sind, ist dies das, was ich normalerweise tue: Ich kommentiere den gesamten...
Diese Frage wurde von Stack Overflow migriert, da sie in Software Engineering Stack Exchange beantwortet werden kann. Vor 7 Jahren migriert . Das Kommentieren ist heutzutage einfacher als je zuvor. In Java gibt es einige nette Techniken zum Verknüpfen von Kommentaren mit...
Ich suche eine Empfehlung für eine bewährte Methode für XML-Kommentare in C #. Wenn Sie eine Eigenschaft erstellen, hat die erwartete XML-Dokumentation anscheinend die folgende Form: /// <summary> /// Gets or sets the ID the uniquely identifies this <see cref="User" /> instance. ///...
Aus einigen Open Source-Projekten habe ich den folgenden Codierungsstil zusammengetragen void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Ich habe immer Zweifel, was falsehier bedeutet. Bedeutet es "vergessen" oder bezieht sich das "vergessen" auf den...
Geschlossen . Diese Frage ist meinungsbasiert . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie mit Fakten und Zitaten beantwortet werden kann, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 4 Jahren . Ich habe oft solche...
Ich habe viele Ausgabenummern aus Kommentaren von jQuery-Code gesehen . (Tatsächlich gab es im jQuery-Code 69 Problemnummern.) Ich denke, es wäre eine gute Praxis, aber ich habe noch nie Richtlinien gesehen. Wenn es sich um eine gute Praxis handelt, welche Richtlinien gelten für diese...
Diese Frage wurde von Stack Overflow migriert, da sie in Software Engineering Stack Exchange beantwortet werden kann. Vor 8 Jahren migriert . Ein paar, aber meines Wissens keine der beliebtesten. Hat das Verschachteln von Kommentaren etwas Schlechtes? Ich plane, Blockkommentare in der (kleinen)...
Der leitende Entwickler in unserem Shop besteht darauf, dass der zuständige Programmierer bei jeder Änderung des Codes einen Inline-Kommentar hinzufügt, der angibt, was er getan hat. Diese Kommentare sehen normalerweise so aus// YYYY-MM-DD <User ID> Added this IF block per bug 1234. Wir...
Einer der Entwickler in meinem Team glaubt, dass es notwendig ist, einen Javadoc-Kommentar für JEDEN Parameter in die Signatur einer Methode zu schreiben. Ich denke nicht, dass dies notwendig ist, und in der Tat denke ich, dass es sogar schädlich sein kann. Zunächst einmal denke ich, dass...
In einigen Codebasen können Sie Kommentare sehen, in denen Dinge wie: // Workaround for defect 'xxx', (See bug 1434594 on Sun's bugparade) Ich habe ein paar Fragen, aber sie hängen alle zusammen. Ist es in Ordnung, in den Kommentaren eines Programms Links zu SO-Fragen zu setzen: // We're now...
Wird es als schlechte Praxis angesehen, NotImplementedExceptionCode zu werfen , den Sie noch nicht geschrieben haben? Möglicherweise wären TODO-Kommentare
Es ist schwer zu sagen, was hier gefragt wird. Diese Frage ist mehrdeutig, vage, unvollständig, zu weit gefasst oder rhetorisch und kann in ihrer gegenwärtigen Form nicht angemessen beantwortet werden. Hilfe zur Klärung dieser Frage, damit sie erneut geöffnet werden kann, erhalten...
Aus heutiger Sicht passt diese Frage nicht zu unserem Q & A-Format. Wir erwarten, dass die Antworten durch Fakten, Referenzen oder Fachwissen gestützt werden, aber diese Frage wird wahrscheinlich Debatten, Argumente, Abstimmungen oder erweiterte Diskussionen hervorrufen. Wenn...