AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Thema durchsuchen
Ansicht
Themen-Optionen

Quellcode Kommentieren

Ein Thema von franktron · begonnen am 5. Aug 2014 · letzter Beitrag vom 16. Aug 2014
Antwort Antwort
Seite 3 von 10     123 45     Letzte »    
Benutzerbild von Bernhard Geyer
Bernhard Geyer

Registriert seit: 13. Aug 2002
17.196 Beiträge
 
Delphi 10.4 Sydney
 
#21

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 16:59
Zitat:
ISO 13485 entwickeln, da gibt es kein SW-Release ohne Doku.
Das betrifft doch nur die Doku und keine Quellcode-Kommentare, oder irre ich mich?
Die Frage ist eher ob primär sinnvolle Doku entsteht oder nur Doku der Doku wegen?
Manche Normen produzieren viel Papier ohne eine mehrwert zu haben.
Windows Vista - Eine neue Erfahrung in Fehlern.
  Mit Zitat antworten Zitat
Benutzerbild von himitsu
himitsu

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

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 17:04
Die Frage ist eher ob primär sinnvolle Doku entsteht oder nur Doku der Doku wegen?
Die nichtvorhandenen Einträge in der Delphi-Doku, wo nur drin steht, daß hier noch nichts drin steht.
Neuste Erkenntnis:
Seit Pos einen dritten Parameter hat,
wird PoSex im Delphi viel seltener praktiziert.
  Mit Zitat antworten Zitat
Benutzerbild von Sherlock
Sherlock

Registriert seit: 10. Jan 2006
Ort: Offenbach
3.798 Beiträge
 
Delphi 12 Athens
 
#23

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 17:14
Zitat:
ISO 13485 entwickeln, da gibt es kein SW-Release ohne Doku.
Das betrifft doch nur die Doku und keine Quellcode-Kommentare, oder irre ich mich?
Wir ziehen Teile der Doku aus dem Quellcode.
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
Oliver
Geändert von Sherlock (Morgen um 16:78 Uhr) Grund: Weil ich es kann
  Mit Zitat antworten Zitat
Benutzerbild von Bernhard Geyer
Bernhard Geyer

Registriert seit: 13. Aug 2002
17.196 Beiträge
 
Delphi 10.4 Sydney
 
#24

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 17:27
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.
So wie tausende Seiten Pflichten/Lastenheft die jeden sch*** bis zum letzten Pixel beschreiben obwohl im länger dauernden Projekt (und das auch jeden klar ist) 95% dieser Dokumentation hinfällig wird.
Windows Vista - Eine neue Erfahrung in Fehlern.
  Mit Zitat antworten Zitat
Hansa

Registriert seit: 9. Jun 2002
Ort: Saarland
7.554 Beiträge
 
Delphi 8 Professional
 
#25

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 18:28
Dejan Vu hat Recht. Der beste Kommentar ist selbsterklärender Quelltext. Dann sind nämlich die Kommentare direkt "impementiert". Bei folgender Zeile einen solchen Kommentar zu schreiben ist völliger Schwachsinn :

procedure test; // das ist die Prozedur Test Hier allerdings (Pseudocode) :

Mwst := Mwst * 1.19; // Achtung : MWST. zu Testzwecken in EXE eincompiliert !! Muss noch geändert werden! 10.XXX 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.
Gruß
Hansa
  Mit Zitat antworten Zitat
Benutzerbild von Nersgatt
Nersgatt

Registriert seit: 12. Sep 2008
Ort: Emlichheim
693 Beiträge
 
Delphi 10.1 Berlin Professional
 
#26

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 18:39
Mwst := Mwst * 1.19; // Achtung : MWST. zu Testzwecken in EXE eincompiliert !! Muss noch geändert werden! 10.XXX
Da würde sich IMO eine Warnung eher anbieten:
{$message Warn 'Achtung : MWST. zu Testzwecken in EXE eincompiliert !! Muss noch geändert werden!'} Dann fällt es einem wenigsten bei jedem Erzeugen auf die Füße. Sofern das Fenster nicht sowieso mit Warnungen überquillt...

Im übrigens bin ich ganz der Meinung von dejan vu.
Jens
  Mit Zitat antworten Zitat
Benutzerbild von sx2008
sx2008

Registriert seit: 16. Feb 2008
Ort: Baden-Württemberg
2.332 Beiträge
 
Delphi 2007 Professional
 
#27

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 20:09
Wir ziehen Teile der Doku aus dem Quellcode.
Da kommt es drauf an, für wen die Software geschrieben wird.
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.
fork me on Github
  Mit Zitat antworten Zitat
Hansa

Registriert seit: 9. Jun 2002
Ort: Saarland
7.554 Beiträge
 
Delphi 8 Professional
 
#28

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 20:31
Ja, auch das ist richtig, aber mich stören trotzdem völlig unnötige Kommentare a la i:= i + 1; // erhöht den Zähler um 1 Wer das nicht versteht (also ohne Kommentar, der ist ohnehin fehl am Platze )
Gruß
Hansa
  Mit Zitat antworten Zitat
Benutzerbild von bernau
bernau

Registriert seit: 1. Dez 2004
Ort: Köln
1.295 Beiträge
 
Delphi 12 Athens
 
#29

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 21:47
Ja, auch das ist richtig, aber mich stören trotzdem völlig unnötige Kommentare a la i:= i + 1; // erhöht den Zähler um 1 Wer das nicht versteht (also ohne Kommentar, der ist ohnehin fehl am Platze )
Ich glaube wir sind uns alle einig, daß solche Kommentare unsinnig sind.

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.
Gerd
Kölner Delphi Usergroup: http://wiki.delphitreff.de
  Mit Zitat antworten Zitat
Dejan Vu
(Gast)

n/a Beiträge
 
#30

AW: Quellcode Kommentieren

  Alt 5. Aug 2014, 22:16
Aber manchmal gibt es "unsinnige Wünsche" von Kunden. So etwas kommentiere ich immer. Teilweise sogar mit Verweis auf die E-Mail des Kunden.
Wir machen das über CVS.
  Mit Zitat antworten Zitat
Antwort Antwort
Seite 3 von 10     123 45     Letzte »    


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 18:35 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