![]() |
AW: Quellcode Kommentieren
Zitat:
z.B. die Tabelle Personen kann für Ansprechpartner, Inhaber, etc. verwendet werden und dort sollte der Alias am besten zum verwendeten Kontext passen :) |
AW: Quellcode Kommentieren
Zitat:
gruß K-H |
AW: Quellcode Kommentieren
Zitat:
Wieder was dazugelernt und das in meinem Alter... |
AW: Quellcode Kommentieren
Zitat:
Zitat:
![]() Die Änderungen beziehen sich dann tatsächlich nur auf die Prozedur/Klasse über der dieser Hinweis ist. Man kann dann die commit-Details aufrufen und aus diesen dann wiederum auf ein Datei-Diff zugreifen. Damit das wirklich weiterhilft, sollte man natürlich kleine Änderungen mit aussagekräftigen Nachrichten machen. Es hilft nichts, wenn man sieht die Prozedur wurde 3 Mal geändert, und die Nachrichten sind "Diverses", "." und "Zeug" :stupid: Ich muss jetzt erstmal schauen, wie sinnvoll/praktisch das ganze ist. Zu Kommentaren im Allgemeinen kann ich übrigens noch folgendes Schmuckstück beitragen:
Code:
// Vorsteuerung: 3000 upm entsprechen 10 m/s ==> Faktor 0,3
int16_t Vorsteuerung = upm_value / 2; // Faktor 0,25 |
AW: Quellcode Kommentieren
Zitat:
|
AW: Quellcode Kommentieren
Das ganze Kommentieren?Ja?Nein?Wann?Wieoft? Gedöns hat ja folgenden Hintergrund:
Als Entwickler ist man (wenn man nicht gerade Code produziert) den lieben langen Tag damit beschäftigt, Code zu verstehen. Implementierungsdetails unterhalb des aktuellen Abstraktionsniveaus sind hier hinderlich: Hier mal zwei Beispiele, die genau das gleiche machen:
Delphi-Quellcode:
if not Customers.FindById(customer.ID) then
Customers.CreateNew(customer);
Delphi-Quellcode:
Das erste versteht man sofort und intuitiv, beim zweiten muss man schon lesen. Klar ist das ordentlich, aber WTF, wen interessieren Details und/oder Kommentare? Wenn ich wissen will, wie neuerdings gesucht wird, gehe ich in die 'Find' Methode rein. Das kostet mich einen Click. Und wenn ich will, wie genau ein neuer Kunde angelegt wird auch.
var
searchRec : TCustomerSearchRec; idFilter : TSearchFilterCriteria; newCustomer : TCustomerEntity; begin // search the customer by creating a customer search record searchRec := TCustomerSearchRec.Create; // this is the new search filter criteria! really cool stuff. Check it idFilter := TSearchFilterCriteria.Create; // 2013-03-04: JFuddle: [CodeImp] replaced constant field names by definition // 2013-07-12: MPeck: Yeah, but replace with the correct one, you moron. :-) idFilter.Field := Customers.DataDescription.Fieldnames.ID; idFilter.Condition := fcoEqual; idFilter.Value = customer.ID; searchRec.Filter.Add(idFilter); // now try to find it if not Customers.Find(searchRec) then begin // nope, not found, create a new one newCustomer := Customers.CreateEntity; newCustomer.Id := customer.Id; newCustomer.Name := customer.Name; .... Customers.Post(newCustomer); end; Wir machen dieses Form des Codelesens 100 mal am Tag. Wenn ich mich jedesmal durch Kommentar und Codearien lesen muss, um das zu verstehen (hier geht das ja noch), dann bin ich genervt, gestresst und viel unproduktiver, als wenn ich mich durch sauberen Code lese, der minimal kommentiert, selbsterklärend und klar strukturiert ist. Ich schaffe mehr, bin produktiver und einfach besser drauf. Wenn ich kein CVS habe, oder ich unbedingt Revisionsinformationen und codechange-Kommentare im Code vorhalten will, dann benötige ich etwas zum Verbergen (codefolding, regions in der Art) dieser fast immer unnützen Information. @jfheins: Genau deshalb sagt man ja, das Kommentare (irgendwann anfanfangen zu) lügen oder einfach Mist erzählen. |
AW: Quellcode Kommentieren
Nun einiges von Deinen Kommentarbeispielen würde bei mir unter "Geschwafel" einsortiert, und dafür ist mir meine Zeit wirklich zu schade.
@jfheins: Da hätten wir einen Grund mal nachzufragen was denn nun eigentlich richtig ist, der Programmierer/Kommentator wußte dies augenscheinlich nicht. Gruß K-H |
AW: Quellcode Kommentieren
Zitat:
|
AW: Quellcode Kommentieren
Zitat:
Es gibt nur ein winziges Problem. Man kann eine Unit dokumentieren (DocInsight), aber das CodeFolding funktioniert bei diesem Kommentar (da oben an/über
Delphi-Quellcode:
) noch nicht. :wall:
unit xyz;
|
AW: Quellcode Kommentieren
Zitat:
|
AW: Quellcode Kommentieren
Die Dokumentation gehört vor/über das zu dokumentierende Objekte und nicht dahinter.
(wobei ich es mit bei Property, Kostante und Co. auch gern mal dahinter gewünscht hätte stupid) Das Erste "in" jeder Unit, also der Uses-Abschnitt, lässt sich nicht dokumentieren und bei Compiler-Optionen geht es natürlich auch nicht. |
Alle Zeitangaben in WEZ +1. Es ist jetzt 02:16 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