Core-Request - Kommentierung von Funktionen
Verfasst: Fr 7. Aug 2009, 08:47
Contenido wird immer umfangreicher, doch auch immer unübersichtlicher.
Wer weiß schon welche Klassen es gibt, und vofür diese alle sind.
Dafür muss, wie für jedes größere Projekt eine API-Referenz her, anhand der man sich einfach und analytisch durchhangeln kann.
Der Grundstein ist gelegt (Contenido API), dennoch erschwert der schlecht kommentierte Quellcode die Arbeit mit der API.
Wären in den Quellcode direkt von Anfang an entsprechende Kommentare hinzugefügt worden, würde man in der erzeugten API direkt alles über die entsprechende Funktion erfahren.
Würde mich sehr freuen, wenn dieses Manko nach und nach aufgearbeitet würde.
Ggf. könnte man ja auch ein Community-Projekt daraus machen:
Man nehme eine aktuelle Stable-Version, und veröffentlicht in einer Liste ein paar (z.B. 5 pro Woche) Klassennahmen, deren Funktionsbeschreibung (also Kommentare für Funktionen) aktualisiert werden sollte. Für die Zeit der Kommentar-aktualisierung wird in diesem Bereich der Core-Code dieser Klassen nicht weiterentwicklet, um keine redundanten Daten zu haben.
Wurden die Beschreibungen angepasst, wird die Beschreibung dann in die aktullen Klassen übernommen und in die Stable-Version aufgenommen.
So könnte man Stück für Stück Contenido gut dokumentieren. Das bringt meiner Meinnug nach gerade den Entwicklern eine imense Zeitersparnis, und kommt so Contenido wieder zugute.
Wa sagt Ihr dazu?
Wer weiß schon welche Klassen es gibt, und vofür diese alle sind.
Dafür muss, wie für jedes größere Projekt eine API-Referenz her, anhand der man sich einfach und analytisch durchhangeln kann.
Der Grundstein ist gelegt (Contenido API), dennoch erschwert der schlecht kommentierte Quellcode die Arbeit mit der API.
Wären in den Quellcode direkt von Anfang an entsprechende Kommentare hinzugefügt worden, würde man in der erzeugten API direkt alles über die entsprechende Funktion erfahren.
Würde mich sehr freuen, wenn dieses Manko nach und nach aufgearbeitet würde.
Ggf. könnte man ja auch ein Community-Projekt daraus machen:
Man nehme eine aktuelle Stable-Version, und veröffentlicht in einer Liste ein paar (z.B. 5 pro Woche) Klassennahmen, deren Funktionsbeschreibung (also Kommentare für Funktionen) aktualisiert werden sollte. Für die Zeit der Kommentar-aktualisierung wird in diesem Bereich der Core-Code dieser Klassen nicht weiterentwicklet, um keine redundanten Daten zu haben.
Wurden die Beschreibungen angepasst, wird die Beschreibung dann in die aktullen Klassen übernommen und in die Stable-Version aufgenommen.
So könnte man Stück für Stück Contenido gut dokumentieren. Das bringt meiner Meinnug nach gerade den Entwicklern eine imense Zeitersparnis, und kommt so Contenido wieder zugute.
Wa sagt Ihr dazu?