Resultados de la búsqueda a petición "documentation"

5 la respuesta

Cómo documentar el código Python con doxygen [cerrado]

Me gusta doxygen para crear documentación de código C o PHP. Tengo un próximo proyecto de Python y creo recordar que Python no tiene/* .. */ comentarios, y también tiene su propia facilidad de autodocumentación que parece ser la forma pitónica ...

2 la respuesta

jsdoc: descripción multilínea @property

Estoy documentando mi código usando jsdoc, hasta ahora todo bien, tengo un comentario como el siguiente ... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * @property...y viene en documento ...

1 la respuesta

Anular la declaración de función en autodoc para esfinge

Tengo un módulo que dice algo como esto:

5 la respuesta

Documentar el código de la biblioteca C ++ / CLI para usar desde c #: ¿mejores herramientas y prácticas? [cerrado]

Estoy trabajando en un proyecto donde se está utilizando una biblioteca c ++ / cli principalmente desde una aplicación c #.¿Hay alguna forma de hacer que los...

5 la respuesta

¿Dónde puedo encontrar buena documentación de AREL? [cerrado

Estoy tratando de aprender todo lo que pueda sobre AREL. Pero no estoy seguro de qué mirar. Encontré algunosdocumentación en rubydoc [http://rubydoc.info/github/rails/arel/master/frames], pero no parece muy bueno en términos de mostrar cuáles ...

30 la respuesta

What is self-documenting code and can it replace well documented code? [cerrado]

3 la respuesta

reST: ¿enlaces en línea con títulos arbitrarios?

Si he definido un objetivo de hipervínculo interno, ¿cómo puedo vincularlo usando texto arbitrario como título del enlace? Por ejemplo _`This is a very long internal link target`. ... A `short reference`_ to the very long link target. ¿Cómo ...

1 la respuesta

Iterando sobre los registros de un Yardoc `@ macro`

Estoy buscando una manera de iterar sobre los registros de un yardoc

3 la respuesta

¿Dónde está la documentación de filterscript (y cómo puedo usarla)? [cerrado]

Cuando Jelly Bean 4.2 fue anunciado hace un mes, Filterscript también fue anunciado. Parece ser un lenguaje que es un subíndice de Renderscript con una exten...

4 la respuesta

Reemplazo de cadenas de documentos de Python [cerrado]

He escrito unepytext [http://epydoc.sourceforge.net/epytext.html]adescanso [http://docutils.sourceforge.net/docs/user/rst/quickref.html]convertidor de marcado, y ahora quiero convertir todas las cadenas de documentos en toda mi biblioteca de ...