Artikel getaggt mit Dokumentation

Praktische Tests mit der Java API

Nachdem Soap, die Benutzerverwaltung und andere Dinge viel Zeit in Anspruch nahmen, habe ich jetzt erstmalig eine Anwendung gebaut, die sich der Java API bedient. Dabei sind noch einige ‘Löcher’ aufgetaucht, die es zu stopfen gab. Vor allem die Initialisierung und das Sicherstellen, dass alle notwendigen Voraussetzungen für den Programmablauf gegeben sind, ist anders, wenn man sich ‘von außen’ der Klassen und ihrer Methoden bedient.

Aber alles in allem war es weniger schlimm, als befürchtet. Nach wenigen Stunden hatte ich eine API bzw. ein Framework, das auch als solches funktioniert. D.h. auch, dass ich mich tatsächlich allmählich daran setzen muss, Pressetexte zusammen zu stellen. Vorher gibt es aber auch noch eine Menge Arbeit mit der Dokumentation.

Tags: , , ,

Dokumentation

Welch leidiges Thema!

Immer wieder darf ich Grundsatzdiskussionen mit meinen Mitarbeitern führen, warum sie – bitteschön – ihre Arbeit bitte, bitte, dokumentieren mögen (bitte!). Hätten sie nicht die Zeit, ok. Sprächen sie nicht deutsch oder englisch, naja. Aber allein der Wille ist, was fehlt. Zeigt sich daran, dass meine besten Entwickler gut ausgelastet, sehr produktiv und dennoch fleißig in der Dokumentation sind. Ich selbst dokumentiere sogar ausgesprochen gerne (offensichtlich bin ich etwas merkwürdig).

Wie auch immer, habe ich in den letzten Tagen einige Stunden dem cook book von CLOUD SEVEN gewidmet. Zugeben muss ich, dass der Aufwand exorbitant steigt, wenn möglichst alle Details berücksichtigt werden sollen. Also wird auch die Dokumentation von CLOUD SEVEN weder ein spannender Roman noch eine wissenschaftliche Abhandlung werden. Dennoch ist das Ziel, dem Anwender an den entscheidenden Stellen Unterstützung durch aufschlussreiche Information zu bieten.

Für die API Nutzer bleibt auch am JavaDoc noch einiges zu tun.

Tags: , , ,