Free Trial

Safari Books Online is a digital library providing on-demand subscription access to thousands of learning resources.

  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint
Share this Page URL
Help

2. Grundlagen > Eine API-Dokumentation schreiben

Eine API-Dokumentation schreiben

Die meisten Entwickler sind der Meinung, das Schreiben einer Dokumentation sei langweilig und würde nicht ausreichend gewürdigt werden. Aber das muss gar nicht der Fall sein. Die API-Dokumentation kann automatisch aus den Kommentaren im Code generiert werden. So kann die Dokumentation erstellt werden, ohne dass man sie selbst schreiben muss. Viele Programmierer finden diese Idee faszinierend, da sich das automatische Generieren einer menschenlesbaren Referenz aus bestimmten Schlüsselwörtern und speziell formatierten »Befehlen« fast wie echtes Programmieren anfühlt.

Klassisch kommen API-Dokumente aus der Java-Welt, in der es ein Tool namens javadoc gibt, das zusammen mit dem Java SDK (Software Developer Kit) ausgeliefert wird. Die gleiche Idee wurde aber auch in viele andere Sprachen übernommen. Für JavaScript gibt es gleich zwei ausgezeichnete Tools, die beide kostenlos und als Open Source zur Verfügung stehen: das JSDoc Toolkit (http://code.google.com/p/jsdoc-toolkit/) und YUIDoc (http://yuilibrary.com/projects/yuidoc).


  

You are currently reading a PREVIEW of this book.

                                                                                                                    

Get instant access to over $1 million worth of books and videos.

  

Start a Free Trial


  
  • Safari Books Online
  • Create BookmarkCreate Bookmark
  • Create Note or TagCreate Note or Tag
  • PrintPrint