¿Cómo generar documentación msdn desde javascript? Preferiblemente usando sandcastle

Question

¿hay alguna herramienta que pueda usar para generar documentación de tipo msdn?

recientemente comencé a jugar con sandcastle y encontré que solía una herramienta llamada scriptdoc pero ha sido absorbida en aptana y realmente no quiero usar aptana studio.

lo que pude encontrar hasta ahora es jsdoc, que es un script de Perl que extrae los comentarios de los archivos de JavaScript, pero todavía estoy buscando un mejor ajuste.

de mi prueba inicial parece que el XML generado a partir de jsdoc no coincide completó con castillos de arena o tal vez me falta algo allí ...

ayuda?

Answer 1

tienes que comentar usando vsdoc ... la sintaxis es como C# vsdoc, pero los comentarios van en la función que estás documentando en lugar de inmediatamente antes. Ejemplo:

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

Es posible que desee comprobar YUIDoc. Es lo que usamos en todos nuestros proyectos, y el resultado final se ve como http://yuilibrary.com/yui/docs/api/classes/Anim.html. Por supuesto, el aspecto es totalmente personalizable con sus propias plantillas, CSS personalizado, etc. por lo que es posible que pueda encontrar algo que se ve completamente diferente