SAPUI5/OpenUI5 Docset Browser

Jedes gute Framework sollte auch eine gute API-Dokumentation haben.

Bei SAPUI5/OpenUI5 ist dies jedoch nur teilweise der Fall. Auf der einen Seite ist die API durch JSDoc teilweise sehr gut dokumentiert, wenn man von einigen kleinen Ausrutschern mal absieht (siehe sap.ui.model.Binding welches als ersten Parameter laut Dokumentation the erwartet, durch fehlende Nennung des Variablennamens).

Leider ist es jedoch sehr schwer an diese Dokumentation ordentlich heranzukommen.
Üblicherweise führt hier der Weg über die offizielle API-Referenz-Seite auf der man entweder sich durch die Baumstruktur navigieren oder die Suche verwenden kann. Die Suche ist jedoch leider eher suboptimal aufgebaut, so führt zum Beispiel bei Eingabe von "sap.m.List" der vierte Treffer in der Ergebnisliste erst zum gewünschten Ziel.

An dieser Stelle kommen Docset-Browser ins Spiel, die die API durchsuchbar machen und den Vorteil der Offline-Fähigkeit mit sich bringen.

Für Mac OS X gibt es hierfür den Browser Dash, während für Linux und Windows Zeal verwendet werden kann.

Beide Browser verwenden das gleiche Format, namens .docset.

Das Docset für SAPUI5/OpenUI5 kann hier heruntergeladen werden in der aktuellen Version 1.52.17

UPDATE: Ab Version 1.28.11 ist dem Docset zusätzlich ein TOC hinzugefügt worden, welches die mit Dash 3 eingeführte Kommentarfunktion für einzelne Funktionen, Eigenschaften, etc. unterstützt.

DocSet Browser: Dash

Ältere Versionen:

View Comments