2215019 Documentacion de Cédigo.himl Documentar nuestro cédigo TypeDoc ejecuta el compilador de TypeScript y extrae informacién de tipo de los simbolos de compilador generados. Por lo tanto, no es necesario incluir metadatos adicionales en los comentarios, los elementos espectficos de TypeScript como clases, enumeraciones o tipos de propiedades y los modificadores de acceso se detectaran autométicamente. Todos los comentarios se analizan como marca. TypeDoc utiliza el analizador de marcado markdown (sttps://github.com/chjj/marked) y HighlightJs (https://github.com/isagalaev/highlight.js) para resaltar los bloques de cédigo dentro de las secciones de reduccién. Ademés, puede vincular a otras clases, miembros o funciones con doble corchetes. JavaDoc tags El generador de documentacién actualmente entiende estas etiquetas javadoc: * @param * @return(s) Todas las demas etiquetas se representardn como listas de definicién, por lo que no se pierden Firmas de Funciones Alescribirla documentacién de las frmas de funciones, no tiene que repetrse. TypeDoc copia automaticamente los comentarios y las etiquetas de la implementacién de la funcién a sus firmas para usted. Por supuesto, todavia puede sobrescribirlas si lo desea. Ejemplo oad * @param text Comentario para el pardmetro text”. * @description Breve descripcién de lo que hace 1a funcién. * @author Quién realizé la funcién. “/ function doSomething(target:any, text:string) :numbers vd * @param value Comentario para el parémetro ‘value’. * @returns Comentario para un valor de retorno. ” function doSomethine(target:anv. value:nunber :number: generated by haroopad fle: /SIASWiDocumentos!2017/Documentosectura/Caidad de Sofware/Documentacén de Cédigo him! 182aisr019 Documentacion de Cédigo.himl id * Comment for method “doSomething ”. * @param target Comentario para el parémetro “target”. * @returns: Comentario para returnar un valor. " function doSomething(target:any, arg:any):number { return @5 } Modulos Los médulos se pueden comentar como cualquier otro elemento en TypeScript. Como los médulos se pueden definir en varios archivos, TypeDoc selecciona el comentario més largo por defecto. Se puede anular este comportamiento con la etiqueta de comentario especial @preferred. ” * Comentarios del médulo actual. * @preferred ” module MyModule { } vd * Comentarios de médulo rechazado. * Este es el comentario més largo pero serd rechazado a favor del comentario preferido ” module MyModule { } Modulos Dinamicos El primer comentario del documento dentro de un archivo se utiliza como comentario doc de un médulo dinémico. Sin embargo, debe asegurarse de que Ia primera declaracién también tiene como comentario doc. va * Este es un comantario de documento para un modulo dindmico. " a generated by haroopad {l:13C:/SIASWIDocumentos/2017/DocumentosiLectura/Calidad de Sotware/Documentacén de Céaliga hm! 2822572019 Documentaciin de Cédigo.himl * Estes es un comentario de documento para "someVar". " var soneVar:string ‘value’; generated by haroopad {l:13C:/SIASWIDocumentos/2017/DocumentsiLectua/Calidad de Sotware/Documentacsén de Céaliga hm! 33