AW: Quellcode Kommentieren
Zitat:
Manche Normen produzieren viel Papier ohne eine mehrwert zu haben. |
AW: Quellcode Kommentieren
Zitat:
|
AW: Quellcode Kommentieren
Zitat:
Doku der Doku wegen ist ne brisante Frage. Da muss man sich mit einem TÜV-ler oder echten Qualitätsmanager drüber unterhalten. Am Ende macht es Sinn, aber es ist verdammt schwer sich dran zu halten. Sherlock |
AW: Quellcode Kommentieren
Zitat:
|
AW: Quellcode Kommentieren
Dejan Vu hat Recht. Der beste Kommentar ist selbsterklärender Quelltext. Dann sind nämlich die Kommentare direkt "impementiert". 8-) Bei folgender Zeile einen solchen Kommentar zu schreiben ist völliger Schwachsinn :
Delphi-Quellcode:
Hier allerdings (Pseudocode) :
procedure test; // das ist die Prozedur Test
Delphi-Quellcode:
Das wäre schon wichtig. Wobei das 10.XXX für Version steht. Dient halt zum Suchen im Source. Kann natürlich nach Belieben verfeinert werden. Und es gibt für solche Fälle direkt in Delphi ja auch noch ToDo.
Mwst := Mwst * 1.19; // Achtung : MWST. zu Testzwecken in EXE eincompiliert !! Muss noch geändert werden! 10.XXX
|
AW: Quellcode Kommentieren
Zitat:
Delphi-Quellcode:
Dann fällt es einem wenigsten bei jedem Erzeugen auf die Füße. Sofern das Fenster nicht sowieso mit Warnungen überquillt... :stupid:
{$message Warn 'Achtung : MWST. zu Testzwecken in EXE eincompiliert !! Muss noch geändert werden!'}
Im übrigens bin ich ganz der Meinung von dejan vu. |
AW: Quellcode Kommentieren
Zitat:
Wer ist die Zielgruppe? Handelt es sich um eine normale Applikation, Webservice, Dienst der verkauft wird um bei Kunden installiert zu werden? Dann braucht man diese Art von Doku nicht. Ist es eine Assembly,Unit,Klassenbibliothek die von anderen Programmierern eingebunden werden soll? Dann gehört es dazu fast jeder public/protected Methode einen Kommentar zu verpassen und die API-Hilfe mit einem Tool erzeugen zu lassen. |
AW: Quellcode Kommentieren
Ja, auch das ist richtig, aber mich stören trotzdem völlig unnötige Kommentare a la
Delphi-Quellcode:
Wer das nicht versteht (also ohne Kommentar, der ist ohnehin fehl am Platze :shock:)
i:= i + 1; // erhöht den Zähler um 1
|
AW: Quellcode Kommentieren
Zitat:
Aber es gibt Kommentare, die ausfürlicher sind als der "sprechende Procedurename". Und die sollte man verwenden. Mein Code ist auch meist selbsterklärend. Aber manchmal gibt es "unsinnige Wünsche" von Kunden. So etwas kommentiere ich immer. Teilweise sogar mit Verweis auf die E-Mail des Kunden. Hat mir in der letzten Zeit schon manches Grübeln erspart. |
AW: Quellcode Kommentieren
Zitat:
|
Alle Zeitangaben in WEZ +1. Es ist jetzt 19:32 Uhr. |
Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz