Come generare la documentazione msdn da javascript? preferibilmente utilizzando sandcastle

Question

c'è uno strumento che posso usare per generare la documentazione di tipo msdn?

Recentemente ho appena iniziato a giocare con sandcastle e ho scoperto che c'era uno strumento chiamato scriptdoc, ma è stato incorporato in aptana e non voglio veramente usare aptana studio.

quello che ho trovato finora è jsdoc che è uno script perl che estrae i commenti dai file javascript ma sto ancora cercando una soluzione migliore.

dal mio test iniziale sembra che l'XML generato da jsdoc non corrisponde completato con castello di sabbia o forse mi manca qualcosa là ...

alcun aiuto?

Answer 1

devi commentare usando vsdoc ... la sintassi è come C# vsdoc, ma i commenti vanno nella funzione che stai documentando invece di prima. Esempio:

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

È possibile controllare YUIDoc. È ciò che usiamo in tutti i nostri progetti e l'output finale assomiglia allo http://yuilibrary.com/yui/docs/api/classes/Anim.html. Naturalmente, l'aspetto è completamente personalizzabile con i tuoi modelli, CSS personalizzati, ecc. In modo che tu possa essere in grado di creare qualcosa che sembra completamente diverso