nicht angemeldet
Hi!
Noch besser ist, wenn Du zu jedem Stück Programm noch eine richtige Dokumentation schreibst und die mit dem Programm synchron hältst. Die Doku gehört dann natürlich mit den Sources ins Repository.
So! Das möchte ich. Ich weiß nur noch nicht, wie ich das anstellen soll! Hat jemand schon Lösungen? Wie kann ich parallel zum PProgrammieren dokumentieren? Und zwar in PHP? Am Liebsten würde ich gleich nach dem Schreiben der Funktion erklären, warum. Aber so viele Kommentare im Quellcode machen ihn unübersichtlich. Wie kann ich so eine History jeder Datei führen?
Es gibt das PHPDoc-Format. Außerdem gibt es Editoren und IDEs mit Codefolding, da kannst du auch die Kommentare ausblenden, wenn du sie nicht sehen willst.
Eine History hast du mit dem Versionsverwaltungstool.
Und wie kann ich einen Gesamtüberblick führen? So dass ich z.B. zentral aufgeführt habe, was ich alles zum nächsten Update des Produktivservers hochladen muss?
Ein Wiki wäre eine Möglichkeit (siehe Trac).
Noch eins: Lohnt es sich, eine IDE wie z.B. Eclipse zu verwenden? Kann man damit die Dokumentation vereinfachen? Oder gibt es eine bessere Alternative? Oder reicht Notepad++?
Zusammen mit einem ordentlich gepflegten PHPDoc kann Eclipse (und auch andere PHP-IDEs) schon beim Programmieren behilflich sein, weil es die PHPDoc-Kommentare als Tooltips anzeigen kann. Notepad++ kann das nicht.
Lo!