Perguntas com a marcação «documentation-generation»

Muitos idiomas suportam comentários de documentação para permitir que um gerador (como javadocou doxygen ) gere documentação de código analisando o mesmo código. O Swift tem algum recurso de comentário de documentação do tipo como este?

238 swift  documentation-generation 

Como posso informar o JSDoc sobre a estrutura de um objeto retornado. Eu encontrei a @return {{field1: type, field2: type, ...}} descriptionsintaxe e tentei: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event or a jQuery …

144 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Como documentar métodos com parâmetros usando as strings de documentação do Python? EDIT: PEP 257 dá este exemplo: 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