Published on September 8, 2009
API Doc Smackdown YUI Doc versus JS Doc Toolkit Monday, September 14, 2009 - 2:25-3:25p
Old School push RA ; push register A to retain the subtotal pop RB ; pop register B to recall the total
Source Code Stakeholders Solution Architects Product Managers QA Engineers Maintenance Engineers Customers
Why not doc? Embedded comments clutter up the code External document is difficult to synchronize
Some IDEs with API Doc Support Eclipse Visual Studio Aptana (ScriptDoc) Resharper for VS IDEA IntelliJ Any others?
YUI Doc Pros and Cons Pros Cons Concise set of tags YUI specific idioms Used by YUI library Overshadowed by YUI supported by YUI Team Small community
JsDoc Toolkit Pros and Cons Pros Cons Deep and broad tab set Sketchy documentation Used by many projects Lacks "anchor" project Well supported Sole developer
Time for a Test Drive ...
Installing YUI Doc Python 2.5 C:Python25 SetupTools $python_homeScriptseasy_install* (executables) .> easy_install pygments .> easy_install simplejson .> easy_install cheetah YUI Doc Distribution bin/example.bat bin/example.sh
1. easy_install pygments 2. easy_install Cheetah 3. easy_install simplejson C:Python25Scriptseasy_install
Installing JsDoc Toolkit Java 1.5 or 1.6 JsDoc Distribution app conf java templates > java -jar jsrun.jar apprun.js -a -t=templatesjsdoc -r app/frame.js appframe app/handler out/jsdoc index.html files.html symbols http://code.google.com/p/jsdoc-toolkit/
YUI Doc vs JsDoc Toolkit YUI Doc Pros YUI Doc Cons Concise set of tabs YUI specific idioms Used by YUI library Overshadowed by YUI Supported by YUI Team Small community Js Doc Pros Js Doc Cons Deep and broad tag set Sketchy documentation Used by many projects Lacks "anchor" project Well supported Sole developer
Style Guide Use <code> style for keywords and name Use in-line links economically Omit parentheses for the general form of methods and constructors Okay to use phrases instead of complete sentences, in the interests of brevity. Use 3rd person (descriptive) not 2nd person (prescriptive) Method descriptions begin with a verb phrase. Class/interface/field descriptions can omit the subject and simply state the object. Use "this" instead of "the" when referring to an object created from the current class. Use "this" instead of "the" when referring to an object created from the current class. Avoid Latin. http://code.google.com/p/jsdoc-toolkit/
Please complete an evaluation.
Presentación que realice en el Evento Nacional de Gobierno Abierto, realizado los ...
In this presentation we will describe our experience developing with a highly dyna...
Presentation to the LITA Forum 7th November 2014 Albuquerque, NM
Un recorrido por los cambios que nos generará el wearabletech en el futuro
Um paralelo entre as novidades & mercado em Wearable Computing e Tecnologias Assis...
The Yahoo UI (YUI) Library is well known for its excellent documentation. One of its secrets is YUI Doc, a Python application used at build time to ...
View 110 Api Doc posts, presentations, experts, and more. Get the professional knowledge you need on LinkedIn.
API Doc Smackdown The Yahoo UI (YUI) Library is well known for its excellent documentation. One of its secrets is YUI Doc, a Python application used at ...
The Ajaxian Framework Summit features the three most popular open source Ajax frameworks holding ... API Doc Smackdown: YUI Doc versus JS Doc ...
@@ -0,0 +1,216 @@ + # -*- coding: utf-8 -*-+ # + # Python Erlang Concurrency Smackdown documentation build configuration file, created by + # sphinx ...
Get access to files anywhere through secure cloud storage and file backup for your photos, videos, files and more with Google Drive.
Whether you’re building a business on YouTube or want to enhance your app with video, a rich set of YouTube APIs can bring your products to life