Hallo. Im Anhang ein Programm zur Spannungsüberwachung/-Steuerung. Nun habe ich im Header-Text (2.Absatz) die gesamte Funktionsbeschreibung geschrieben. Klar, Geschmackssache, aber... Macht es eher Sinn, solch eine Funktionsbeschreibung in eine separate Text-Datei zu schreiben? In Anbetracht dessen, dass zukünftige Programme umfangreicher werden.
Hmm... ich persönlich finde es "too much". Die Sachen die du da ansprichst haben ja nicht so richtig was mit den Funktionen zu tun sondern sind eher eine Beschreibung des kompletten Projekts. Gruß Dennis
Gast
#4452870
__Son´s B. schrieb: > Macht es eher Sinn, solch eine Funktionsbeschreibung in eine separate > Text-Datei zu schreiben? In welchen Header moechtest du denn die Programmbeschreibung machen, wenn es groesser ist und aus mehreren Dateien besteht? Und die Beschreibung schon deutlich groesser ist, als main() {...}? Und einer ordentlichen Dokumentation schaden grafische Darstellungen, die ueber ASCII-Art hinaus gehen, auch nicht. Ich denke, die Frage beantwortet sich von selbst.
__Son´s B. schrieb: > Im Anhang ein Programm zur Spannungsüberwachung/-Steuerung. Du erwartest nicht ernsthaft, daß sich das jemand durchliest, oder? > Nun habe ich im Header-Text (2.Absatz) die gesamte Funktionsbeschreibung > geschrieben. Schön. > Klar, Geschmackssache, aber... > Macht es eher Sinn, solch eine Funktionsbeschreibung in eine separate > Text-Datei zu schreiben? Die Antwort ist fast immer: Nein. Dokumentation gehört in den Quellcode. Die Idee ist, Quellcode und Dokumentation immer so nahe wie möglich beieinander zu halten, damit beide nicht unbeabsichtigt auseinander driften. Merke: das bedeutet nicht, daß die Dokumentation nicht aus dem Quellcode extrahiert und in eine besser lesbare Form (HTML mit Referenzen oder LaTeX für Ausdrucke) extrahiert werden darf. Aber die primäre Quelle der Dokumentation sollte der Quellcode sein. Es gibt dafür auch jede Menge fertige Tools: javadoc, doxygen, perceps. Stichwort für Google: documentation generator
Gast
#4453051
Drauf sehen, Fehler gefunden:
>>Ustep= 5V/1023= 0,00489V/Step= 4,89mV/Step (Step==LSB)
Das muss 1024 sein.
__Son´s B. schrieb: > Im Anhang ein Programm Wie wäre es, wenn du den C-Programmen den Nachnamen *.c und den Headern den Nachnamen *.h geben würdest? > #define F_CPU 1000000 // int.Takt auf 1MHz gestellt Solche Kommentare sind unnötig, wenn und weil sie nur das darstellen, was 2 Worte weiter vorne eh beschrieben ist. Oder sogar viel mehr vorgaukeln als die Zeile kurz davor macht... :-o BTW: >> Ustep = 5V/1023 >> AL...Auflösung (1023 Steps) Ein Fehler wird auch durch ausdauernde Wiederholung nicht automatisch richtig. Denn auch dein ADC hat wie jeder andere 10-Bit Wandler eine Auflösung von 1024 Schritten. Siehe dazu den Beitrag "1023 oder 1024"