Preguntas etiquetadas con documentation-generation

Muchos lenguajes soportan comentarios de la documentación para permitir un generador (como javadoco doxygen ) para generar documentación de código mediante el análisis de ese mismo código. ¿Swift tiene algún tipo de comentario de documentación como este?

238 swift  documentation-generation 

¿Cómo puedo decirle a JSDoc sobre la estructura de un objeto que se devuelve? Encontré la @return {{field1: type, field2: type, ...}} descriptionsintaxis y la probé: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

¿Cómo documentar métodos con parámetros utilizando las cadenas de documentación de Python? EDITAR: PEP 257 da este ejemplo: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: …

139 python  documentation  documentation-generation