How to create msdn documentation from javascript? preferably using a sand castle

Question

is there any tool i can use to create documentation like msdn?

Recently I just started playing with sandcastle and I found that it was used for a tool called scriptdoc, but it was absorbed by aptana and I really don't want to use aptana studio.

what I could find so far is jsdoc, which is a perl script that extracts comments from javascript files, but I'm still looking better.

from my initial testing it seems that the xml generated from jsdoc does not match the one completed with the sandcast, or maybe something is missing for me ...

any help?

Answer 1

You might want to check out YUIDoc. This is what we use in all of our projects, and the end result looks like http://yuilibrary.com/yui/docs/api/classes/Anim.html . Of course, the look is completely customizable with your own templates, custom CSS, etc., so you can come up with something completely different.

Answer 2

you need to comment using vsdoc ... the syntax is similar to C # vsdoc, but the comments go to the function you are documenting, not immediately. Example:

function foo(bar) { /// <summary>a function called foo</summary> /// <param name="bar"> a param called bar </param> /// <returns type="Boolean">Boolean value of bar </returns> return !!bar; }