Wie msdn Dokumentation von Javascript generieren? vorzugsweise mit Sandcastle

Question

Gibt es ein Tool, das ich verwenden kann, um msdn Typ Dokumentation zu generieren?

ich habe vor kurzem angefangen zu spielen mit sandcastle und ich fand, dass es ein werkzeug namens scriptdoc verwendet, aber es wurde in aptana absorbiert und ich möchte nicht wirklich aptana studio verwenden.

was ich bis jetzt finden konnte, ist jsdoc, das ist ein Perl-Skript, das Kommentare von Javascript-Dateien extrahiert, aber ich bin immer noch auf der Suche nach einer besseren Passform.

von meinen ersten Tests scheint es, dass der von jsdoc generierte XML nicht mit Sandburg abgeschlossen paßt oder vielleicht etwas da fehle ich ...

jede mögliche Hilfe?

Answer 1

Sie müssen kommentieren mit vsdoc ... die Syntax ist wie C# vsdoc, aber Kommentare gehen in die Funktion, die Sie dokumentieren, anstatt unmittelbar zuvor. Beispiel:

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; 
} 

Answer 2

Sie können YUIDoc überprüfen. Es ist, was wir in allen unseren Projekten verwenden, und die endgültige Ausgabe sieht wie http://yuilibrary.com/yui/docs/api/classes/Anim.html aus. Natürlich ist das Aussehen mit Ihren eigenen Vorlagen, benutzerdefinierten CSS, etc. vollständig anpassbar, so dass Sie vielleicht etwas völlig anders aussehen können