gorzka
Anmeldungsdatum: 23. Oktober 2004
Beiträge: 557
Wohnort: Halberstadt
|
Morgen, Ich habe da mal ein Frage zur Verwaltung von Quellcode. Mit CVS kann ich ja die Versionskontrolle machen, aber was nehmt Ihr zum dokumentieren des Codes? Es muss doch festgehalten werden welche Variablen welche Inhalte darstellen, welche Funktionen für was sind. Vielen Dank schon mal Thomas
|
JuergenF
Anmeldungsdatum: 22. Oktober 2004
Beiträge: 2009
Wohnort: FFM
|
aber was nehmt Ihr zum dokumentieren des Codes?
Kommentare ☺ Falls Du daraus z.B. HTML-Docs erzeugen willst, solltest Du mal Doxygen anschauen.
|
gorzka
(Themenstarter)
Anmeldungsdatum: 23. Oktober 2004
Beiträge: 557
Wohnort: Halberstadt
|
Kommentare sind gut. Aber bei einem Projekt wie z.B. einem CMS müssen doch alle wissen welche Variablen für was stehen. Ohne Dokumentation geht doch da wohl gar nichts.
|
Gizzmo
Anmeldungsdatum: 30. November 2005
Beiträge: 360
Wohnort: München
|
Um welche Sprache handelt es sich denn?
|
adun
Anmeldungsdatum: 29. März 2005
Beiträge: 8606
|
Die besseren Sprachen können sich automatisch dokumentieren. Kommt also drauf an was du benutzt. Ich würde svn cvs jederzeit vorziehen.
|
Klaus1977
Anmeldungsdatum: 10. April 2005
Beiträge: 269
Wohnort: Aschaffenburg
|
Ich denk gorzka meint sowas: Doxygen http://www.stack.nl/~dimitri/doxygen/ Hab ich leider noch nicht ausprobiert! Zur Versionsverwaltung nehme ich auch Subversion Gruß Klaus
|
gorzka
(Themenstarter)
Anmeldungsdatum: 23. Oktober 2004
Beiträge: 557
Wohnort: Halberstadt
|
Es handelt sich um PHP. Nun arbeite ich an einem Projekt mit mehreren Leuten zusammen. Für die Verwaltung der Dateien werde ich mich in Subversaion einarbeiten. Nun fange ich an mit Programmieren und nehme für das Datum die Variable a und zerteile den String in b,c,d für Tag Monat und Jahr. Ich selbst weis ja in welcher variable was drin steht, aber die anderen ja nicht. Nun könnte ich ja im Kommentar jedesmal reinschreiben welche Variable wie belegt ist und könnte zusätzlich noch eine Textdatei anlegen, die ich jedesmal mit weitergebe. Schließlich möchte man ja Doppelbelegungen und somit Fehler vermeiden. Ich dachte nun, daß es genau für dieses Problem schon ein Programm gibt.
|
JuergenF
Anmeldungsdatum: 22. Oktober 2004
Beiträge: 2009
Wohnort: FFM
|
Doxygen kann PHP scheinbar nur mit Einschränkungen. Dafür gibts aber wohl http://www.phpdoc.org , hab ich allerdings nicht in den Ubuntu-Paketen gefunden - musst also 'manuell' installieren.
|
irgendwer
Anmeldungsdatum: 3. November 2004
Beiträge: 158
|
gorzka hat geschrieben:
Nun fange ich an mit Programmieren und nehme für das Datum die Variable a und zerteile den String in b,c,d für Tag Monat und Jahr. Ich selbst weis ja in welcher variable was drin steht, aber die anderen ja nicht.
Ich mach es so, dass ich bis auf Counter Variablen (für Schleifen) meinen Variablen eindeutige Namen gebe, also würde ich wirklich in deinem Fall die Variablen, date, day, month und year nennen, dann hast du schon mal nicht das Problem, dass du die extra kommentieren musst. Jetzt sagst du vielleicht, naja da hab ich ja dann mehr Schreibarbeit, wenn ich die irgendwo verwende, aber wenn du jetzt mit einbeziehst, dass du die sonst noch extra kommentieren müsstest, dann kommst du doch auf weniger Schreibarbeit 😉. mfg Andy
|
user_unknown
Anmeldungsdatum: 10. August 2005
Beiträge: 17548
Wohnort: Berlin
|
Erstmal volle Zustimmung zu andreasw. gorzka hat geschrieben: Nun könnte ich ja im Kommentar jedesmal reinschreiben welche Variable wie belegt ist und könnte zusätzlich noch eine Textdatei anlegen, die ich jedesmal mit weitergebe. Schließlich möchte man ja Doppelbelegungen und somit Fehler vermeiden.
Wieso Doppelbelegungen? Benutzt Du etwa globale Variablen? M.W. hat die Unterstützung objektorientierter Techniken in PHP zuletzt Fortschritte gemacht, und globale Variablen sind :pfui: .
|
gorzka
(Themenstarter)
Anmeldungsdatum: 23. Oktober 2004
Beiträge: 557
Wohnort: Halberstadt
|
Das mit den variablen a,b,c war ja nur als Beispiel gedacht. Ich nehme schon eindeutige Variablen. Wenn ich z.B. eine variable $hotelname nehme und vielleicht noch eine Variable $vonheute weiss ja der Mitprogrammierer nicht wirklich was diese bedeuten und in einem jahr, wenn vielleicht einer etwas ändern muß ja auch nicht mehr. deshalb ist ja eine gute Doku manchmal mehr wert als ein Kilo Gold 😉
|
Herrscher
Anmeldungsdatum: 12. Oktober 2005
Beiträge: 65
|
gorzka hat geschrieben: Wenn ich z.B. eine variable $hotelname nehme und vielleicht noch eine Variable $vonheute weiss ja der Mitprogrammierer nicht wirklich was diese bedeuten und in einem jahr, wenn vielleicht einer etwas ändern muß ja auch nicht mehr.
Also ich würde denken, in $hotelname steht der Name eines Hotels. :twisted: $vonheute ist allerdings schlecht gewählt, das ist wirklich nichtssagend. Ich habe mir für Doku-Zwecke ein Wiki aufgesetzt, z.Z. vqwiki als Java Servlet in Tomcat. Da Du eh PHP machst, wäre vielleicht ein PHP-Wiki interessanter für Dich. Trotzdem geht nichts über gute Bezeichner, $vonheute ist scheiße! $ReservierungenVonHeute ist eindeutig besser. Siehe dazu auch "How To Write Unmaintainable Code" (google). Diese Sachen (eben nicht) beherzigen... 😉 8)
|
gorzka
(Themenstarter)
Anmeldungsdatum: 23. Oktober 2004
Beiträge: 557
Wohnort: Halberstadt
|
Danke, ich werde mir auf jedenfall mal ein Wiki anschauen. Das mit den Variablennamen sollten auch nur Beispiele gewesen sein. Ein eindeutiger Variablenname ist immer besser. Ich habe mir mal PHPEclipse installiert. Das Teil scheint gar nicht schlecht zu sein. Da kann man einen PHPocumentor mit reinbringen, der dann den Quellcode durchforstet. Das einzige was ich bisher noch nicht hinbekommen habe ist der Debugger.
|