Softwareentwicklung comments

7

Kommentierungs- / In-Code-Dokumentationsstile

Das mag eine dumme Frage sein, aber sie ist schon eine Weile in meinem Hinterkopf und ich kann nirgendwo anders eine anständige Antwort finden. Ich habe einen Lehrer, der sagt, wir sollten jeden Parameter explizit mit einer Beschreibung auflisten, auch wenn es nur einen gibt. Dies führt zu vielen Wiederholungen: …

9 documentation comments coding-style

5

Ist es im Allgemeinen hilfreich, JIRA-Probleme in Codekommentare aufzunehmen?

Hin und wieder hinterlasse ich Kommentare wie # We only need to use the following for V4 of the computation. # See APIPROJ-14 for details. oder # We only need to use the following for V4 of the computation. # See https://theboringcompany.atlassian.net/browse/DIGIT-827 for details. Mein Hauptanliegen dabei ist, dass dies …

8 project-management coding-style communication comments jira

3

Ist das Lesen von Javadoc dem Lesen von Quellcode vorzuziehen, um sich mit einer Bibliothek vertraut zu machen?

Ich bin gerade in einem Laborhandbuch an der Universität auf Folgendes gestoßen: Sie müssen die Schnittstellen der Klassen studieren, indem Sie das Javadoc für sie generieren, damit Sie wissen, welche Operationen bereitgestellt werden (Sie können sich den Code ansehen, aber wenn Sie wie hier den Code eines anderen verwenden, sollten …

8 source-code comments javadocs

3

Warum fehlen einigen OpenSouce-Bibliotheken Kommentare?

Ich weiß nicht, ob dies bei den meisten Opensource-Bibliotheken der Fall ist, aber viele von mir kennen und verwenden (z. B. OpenSSL, Webkit, ...), denen alle Kommentare fehlen oder die nur sehr wenige Kommentare enthalten. Ganz zu schweigen von den wenigen Dokumenten, deren Quellcode schwer zu lesen ist. Wir können …

8 open-source libraries comments document

4

Wie werden Kommentare in Programmiersprachengrammatiken ausgedrückt?

Ich lerne, wie man Parser mit Grammatiken erstellt, aber ich habe versucht, Kommentare auszudrücken, weil sie fast überall erscheinen können. Dies zeigt an, dass Kommentare aus dem Token-Stream entfernt werden können, bevor das Parsen stattfindet. Ist das die Standardpraxis oder werden Kommentare jemals / oft in Grammatiken angegeben?

8 comments parsing grammar

8

Hat der Kommentarstil Einfluss darauf, wie Leser Code verstehen?

Diese Frage beschäftigt mich seit 2 Monaten. Vor einiger Zeit gab mir ein Freund, der ein großartiger Programmierer ist, einige Beispielcodes, und zum ersten Mal bemerkte ich einen einzigartigen Stil beim Organisieren von Kommentaren. Er bemühte sich, Kommentare so zu gestalten, dass ich mich mit dem Code selbst besser auskenne. …

8 comments

11

Was sollte ich beim Festschreiben der Quellcodeverwaltung in Kommentare einfügen?

Möchten Sie diesen Beitrag verbessern? Geben Sie detaillierte Antworten auf diese Frage, einschließlich Zitaten und einer Erklärung, warum Ihre Antwort richtig ist. Antworten ohne ausreichende Details können bearbeitet oder gelöscht werden. Ich bin ein Einzelentwickler und unterhalte einen SVN-Server für die Quellcodeverwaltung. Bisher habe ich beim Festschreiben meiner Änderungen nichts …

8 version-control comments

4

Sollte sich die Syntax zum Deaktivieren von Code von der von normalen Kommentaren unterscheiden?

Aus mehreren Gründen kommentiere ich während der Entwicklung manchmal Code aus. Da ich chaotisch bin und es manchmal eilig habe, schaffen es einige von ihnen zur Quellcodeverwaltung. Ich benutze auch Kommentare, um Codeblöcke zu klären. Zum Beispiel: MyClass MyFunction() { (...) // return null; // TODO: dummy for now return …

8 comments syntax

6

<! - open -> Warum machen so viele Entwickler dies in ihrem HTML? <! - / close ->

<body>  <div id="wrapper">  <div id="title"><img src="title.png" alt="" /></div>  <div id="form_wrapper">  <form action="thankyou.php" method="POST">  </form>  </div>  </div>  </body> Ich kann das am …

8 comments html

Als «comments» getaggte Fragen