AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Delphi-PRAXiS - Lounge Klatsch und Tratsch Eure besten Quellcode Kommentare...
Thema durchsuchen
Ansicht
Themen-Optionen

Eure besten Quellcode Kommentare...

Ein Thema von Relicted · begonnen am 20. Jul 2007 · letzter Beitrag vom 1. Okt 2022
Antwort Antwort
Seite 1 von 2  1 2      
r2c2

Registriert seit: 9. Mai 2005
Ort: Nordbaden
925 Beiträge
 
#1

AW: Eure besten Quellcode Kommentare...

  Alt 12. Dez 2013, 21:19
Diese nutzlosen und verwirrenden Kommentare hab ich mir in längerem Code, zusammen mit zusammenhängenden Blöcke umschlossenen von doppelten Leerzeilen (hier grad nicht) und horizontalen Minus-Linien (also //-----) an "Inhalts-Umbrüchen", angewöhnt und meine Kollegen haben sich das teilweise abgeschaut.
Das ist ein Zeichen dafür, dass deine Methoden zu lang sind. "Inhaltliche Trennungen" macht man am besten durch syntaktische Trennungen. Neue Methoden, neue Klassen, etc. Und damit sind die Ganze Kommentiererei auch schon überflüssig. Darf ich ein Buch empfehlen? Clean Code.
Kaum macht man's richtig, schon klappts!
  Mit Zitat antworten Zitat
Headbucket

Registriert seit: 12. Dez 2013
Ort: Dresden
172 Beiträge
 
Delphi 10.2 Tokyo Professional
 
#2

AW: Eure besten Quellcode Kommentare...

  Alt 13. Dez 2013, 10:57
Wenn mehrere Leute am selben Code arbeiten:

//FreeAndNil(td^.tr[2]); //2 Kanal brauchen wir nicht //brauchen wir doch //To-Do

Gruß
Headbucket
  Mit Zitat antworten Zitat
Benutzerbild von Tonic1024
Tonic1024

Registriert seit: 10. Sep 2003
Ort: Cuxhaven
559 Beiträge
 
RAD-Studio 2009 Ent
 
#3

AW: Eure besten Quellcode Kommentare...

  Alt 13. Dez 2013, 13:58
Das ist ein Zeichen dafür, dass deine Methoden zu lang sind.
Das ist reine Theorie.

Wenn man zum Beispiel einem Webserver einige Aufgaben gibt, so steht der Code im Indys OnCommandGet Routine. Wenn man jetzt hin geht und die individuelle Parameter Detektion in eine Funktion auslagert und jede einzelne Aufgabe in eine separate Funktion auslagert braucht man dennoch die selben 10 Zeilen (okay, sehr ähnliche 10 Zeilen) im Code wieder und wieder und wieder untereinander. Ein fürs Auge leicht wieder zu findender grüner "Eyecatcher" ist beim scrollen sehr hilfreich. Die Länge der Methode ist damit, unabhängig davon ob man ein Buch gelesen hat oder nicht, direkt abhängig vom Funktionsumfang des Servers. Nur mal ein Beispiel.

Oder ein Gegensätzliches. Wenn man komplexe aber dennoch überschaubare Aufgaben (z.B. Stream empfangen, manipulieren und weiterleiten) solange in separate Routinen aufteilt bis kaum noch ersichtlich ist welche Nebenwirkungen eine Änderung in einer Sub-Sub-Routine hätte ist das auch nicht besonders übersichtlich.

Ich wundere mich warum hier so eine Abneigung gegen Kommentare mit optischem Charakter herrscht. Ich hab noch beigebracht bekommen über jede Routine einen Funktionsbeschreibung, Parameterdefinition, Precondition und Postcondition zu tippen.
Der frühe Vogel fängt den Wurm, richtig.
Aber wird nicht auch der frühe Wurm vom Vogel gefressen?

Geändert von Tonic1024 (13. Dez 2013 um 14:09 Uhr)
  Mit Zitat antworten Zitat
Benutzerbild von p80286
p80286

Registriert seit: 28. Apr 2008
Ort: Stolberg (Rhl)
6.659 Beiträge
 
FreePascal / Lazarus
 
#4

AW: Eure besten Quellcode Kommentare...

  Alt 13. Dez 2013, 14:40
Ich wundere mich warum hier so eine Abneigung gegen Kommentare mit optischem Charakter herrscht. Ich hab noch beigebracht bekommen über jede Routine einen Funktionsbeschreibung, Parameterdefinition, Precondition und Postcondition zu tippen.
Wie üblich gilt auch hier "Es kommt darauf an".
Manchmal sind selbst Kommentare wie
Code:
a:=b shr 1; // div 2
durchaus angebracht.

Gruß
K-H
Programme gehorchen nicht Deinen Absichten sondern Deinen Anweisungen
R.E.D retired error detector
  Mit Zitat antworten Zitat
Benutzerbild von himitsu
himitsu

Registriert seit: 11. Okt 2003
Ort: Elbflorenz
44.326 Beiträge
 
Delphi 12 Athens
 
#5

AW: Eure besten Quellcode Kommentare...

  Alt 13. Dez 2013, 14:51
Manchmal sind selbst Kommentare wie
Code:
a:=b shr 1; // div 2
durchaus angebracht.
Wenn b ein Integer ist, dann wäre der Kommentar falsch.
ber ja, hier hättest du Recht.
Wobei der Kommentar nichts doppelt sinnlos erklärt, sondern das shr erklärt.
Ein Therapeut entspricht 1024 Gigapeut.
  Mit Zitat antworten Zitat
Benutzerbild von Valle
Valle

Registriert seit: 26. Dez 2005
Ort: Karlsruhe
1.223 Beiträge
 
#6

AW: Eure besten Quellcode Kommentare...

  Alt 13. Dez 2013, 14:56
Kommentare können durchaus äußerst sinnlos werden.

An meiner Uni gibt es bei der Abgabe der Aufgaben zur Programmieren-Vorlesung eine automatische Überprüfung auf Stil und Kommentierung. Das endet dann in solchen Stilblüten, damit der Automat fehlerfrei durchläuft:

(Dabei sei hervorgehoben, dass nicht nur die Kommentierung jedes einzelnen Enum-Elements sinnlos ist, sondern auch diese inline-Versionierung und Angabe des Autors. Was um Himmels Willen soll der Quatsch denn?!)

Code:
/**
 * Eine einfache Definition eines Wochentags.
 * @version 1.0
 * @author Valentin Voigt
 */

enum Weekday {
   
   /**
    * Sonntag   
    */
   
   SUNDAY,
   
   /**
    * Montag
    */
   
   MONDAY,
   
   /**
    * Dienstag
    */
   
   TUESDAY,
   
   /**
    * Mittwoch
    */
   
   WEDNESDAY,
   
   /**
    * Donnerstag
    */
   
   THURSDAY,
   
   /**
    * Freitag
    */
   
   FRIDAY,
   
   /**
    * Samstag
    */
   
   SATURDAY
}
Valentin Voigt
BOFH excuse #423: „It's not RFC-822 compliant.“
Mein total langweiliger Blog
  Mit Zitat antworten Zitat
Namenloser

Registriert seit: 7. Jun 2006
Ort: Karlsruhe
3.724 Beiträge
 
FreePascal / Lazarus
 
#7

AW: Eure besten Quellcode Kommentare...

  Alt 14. Dez 2013, 00:24
Kommentare können durchaus äußerst sinnlos werden.

An meiner Uni gibt es bei der Abgabe der Aufgaben zur Programmieren-Vorlesung eine automatische Überprüfung auf Stil und Kommentierung. Das endet dann in solchen Stilblüten, damit der Automat fehlerfrei durchläuft:

(Dabei sei hervorgehoben, dass nicht nur die Kommentierung jedes einzelnen Enum-Elements sinnlos ist, sondern auch diese inline-Versionierung und Angabe des Autors. Was um Himmels Willen soll der Quatsch denn?!)
Der Code hat mich gleich an die Programmieren-Vorlesung hier erinnert... dann ist mir aufgefallen, dass du ja auch in Karlsruhe studierst

Als ich das erste (und letzte ) mal im Programmieren-Tutorium war und der Tutor uns zeigte, wie man jedes einzelne Klassenmember mit einem dreizeiligen Kommentar versehen soll, dachte ich erst, es wäre ein Scherz

Naja, aktuell mache ich hier dieses Softwarepraktikum (nicht am KIT), und da ist jetzt von den Coding Conventions gefordert, zwischen alle Funktionsdefinitionen solche Trennlinien zu machen:

//============================================================================

Auch sehr sinnlos... wobei der Rest recht vernünftig ist, das macht es für mich noch irritierender.
  Mit Zitat antworten Zitat
Benutzerbild von Meflin
Meflin

Registriert seit: 21. Aug 2003
4.856 Beiträge
 
#8

AW: Eure besten Quellcode Kommentare...

  Alt 14. Dez 2013, 01:11
Naja, aktuell mache ich hier dieses Softwarepraktikum (nicht am KIT), und da ist jetzt von den Coding Conventions gefordert, zwischen alle Funktionsdefinitionen solche Trennlinien zu machen:

//============================================================================
Wie dumm ist das denn? Vor allem, wenn man bedenkt, dass ein durchschnittlicher Editor sowas heutzutage von selbst einfügen anzeigen kann, sofern man es denn haben will
Leo S.
  Mit Zitat antworten Zitat
Mikkey

Registriert seit: 5. Aug 2013
265 Beiträge
 
#9

AW: Eure besten Quellcode Kommentare...

  Alt 13. Dez 2013, 15:01
[QUOTE=himitsu;1239686]
Wobei der Kommentar nichts doppelt sinnlos erklärt, sondern das shr erklärt.
Sinnlos is m.E. eher die Anweisung selbst. Wenn ich durch zwei teilen will (was laut Kommentar ja die Absicht ist), dann sollte ich das auch so schreiben;

Code:
a := b div 2;
Optimierung im Algorithmus mag ja sinnvoll sein, aber ob eine Shift-Operation schneller als die Teilungsoperation ist, sollte man dem Compiler überlassen.

Es mag aber durchaus geeignetere Beispiele geben, wo diese Art von Kommentar sinnvoll ist.
  Mit Zitat antworten Zitat
Benutzerbild von Memnarch
Memnarch

Registriert seit: 24. Sep 2010
737 Beiträge
 
#10

AW: Eure besten Quellcode Kommentare...

  Alt 19. Dez 2013, 16:52
Code:
a := b div 2;
Optimierung im Algorithmus mag ja sinnvoll sein, aber ob eine Shift-Operation schneller als die Teilungsoperation ist, sollte man dem Compiler überlassen.
Yep, ein shr ist in dem Fall schneller als ein DIV. Liegt daran, das eine DIV-Operation(welche direkt in der CPU integriert ist) sehr aufwendig ist, da sie im allgemeinen an das mathematische Problem rangeht.(von +-*/ ist / bzw DIV die langsamste)

mit shr nimmst du bei Dvisionen durch eine Zweierpotenz(2, 4, 8, 16) eine unkomplizierte Abkürzung. ein shr ist vergleichweise schnell erledigt auf der CPU. Die logik dahinter ist einfach unkomplizierter.

EDIT: Und falls jemand fragt: Nein, in einer normalen Anwendung ist das komplett Hupe, ob man div oder shr nimmt(hier würde ich der Lesbarkeithalber eher div empfehlen). Aber mein Softwarerenderer hat's mir gedankt

Grüße
Memnarch
Da man Trunc nicht auf einen Integer anwenden kann, muss dieser zuerst in eine Float kopiert werden

Geändert von Memnarch (19. Dez 2013 um 16:58 Uhr)
  Mit Zitat antworten Zitat
Antwort Antwort
Seite 1 von 2  1 2      

 

Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 02:49 Uhr.
Powered by vBulletin® Copyright ©2000 - 2025, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz