26
API Doc Smackdown YUI Doc versus JS Doc Toolkit Monday, September 14, 2009 - 4:30-5:30p

Ted Husted Api Doc Smackdown Ae2009

Embed Size (px)

Citation preview

Page 1: Ted Husted Api Doc Smackdown Ae2009

API Doc Smackdown

YUI Doc versus JS Doc Toolkit Monday, September 14, 2009 - 4:30-5:30p

Page 2: Ted Husted Api Doc Smackdown Ae2009

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 build time to generate API documentation for JavaScript code.

But is YUI Doc really better than JS Doc Toolkit? -- an elder application, written in JavaScript, that also generates API documentation. When should you choose one over the other? Which is the better choice for your project?

In this session you will learn:

* How API generators work, and how documentation helps;* When to use YUI Doc and when to use JS Doc Toolkit;* More about alternatives to comment-based documentation.

Page 3: Ted Husted Api Doc Smackdown Ae2009
Page 4: Ted Husted Api Doc Smackdown Ae2009
Page 5: Ted Husted Api Doc Smackdown Ae2009
Page 6: Ted Husted Api Doc Smackdown Ae2009
Page 7: Ted Husted Api Doc Smackdown Ae2009
Page 8: Ted Husted Api Doc Smackdown Ae2009
Page 9: Ted Husted Api Doc Smackdown Ae2009
Page 10: Ted Husted Api Doc Smackdown Ae2009
Page 11: Ted Husted Api Doc Smackdown Ae2009
Page 12: Ted Husted Api Doc Smackdown Ae2009
Page 13: Ted Husted Api Doc Smackdown Ae2009
Page 14: Ted Husted Api Doc Smackdown Ae2009
Page 15: Ted Husted Api Doc Smackdown Ae2009
Page 16: Ted Husted Api Doc Smackdown Ae2009
Page 17: Ted Husted Api Doc Smackdown Ae2009
Page 18: Ted Husted Api Doc Smackdown Ae2009
Page 19: Ted Husted Api Doc Smackdown Ae2009
Page 20: Ted Husted Api Doc Smackdown Ae2009
Page 21: Ted Husted Api Doc Smackdown Ae2009
Page 22: Ted Husted Api Doc Smackdown Ae2009
Page 23: Ted Husted Api Doc Smackdown Ae2009

Style GuideUse <code> style for keywords and nameUse in-line links economicallyOmit parentheses for the general form of methods and constructorsOkay 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.

Page 24: Ted Husted Api Doc Smackdown Ae2009
Page 25: Ted Husted Api Doc Smackdown Ae2009

Please complete an evaluation.

Page 26: Ted Husted Api Doc Smackdown Ae2009

Questions?