Вопросы с тегом «documentation-generation»

Многие языки поддерживают комментарии к документации, чтобы генератор (например, javadocили doxygen ) мог генерировать документацию кода, анализируя тот же код. Есть ли у Swift какая-либо функция комментариев к документации типа?

238 swift  documentation-generation 

Как я могу сообщить JSDoc о структуре возвращаемого объекта. Я нашел @return {{field1: type, field2: type, ...}} descriptionсинтаксис и попробовал: /** * 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 event wrapping such an …

156 javascript  documentation-generation  jsdoc  code-documentation  jsdoc3 

Как документировать методы с параметрами, используя строки документации Python? РЕДАКТИРОВАТЬ: PEP 257 дает этот пример: 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: return complex_zero ... …

139 python  documentation  documentation-generation