Resultados de la búsqueda a petición "documentation"
Mejora de la legibilidad del código [cerrado]
Cuando se trata de la documentación del código, generalmente se acepta que el código debeexplícate, y la documentación del código en línea (excluyendo la documentación pública de la API) solo debe explicar los problemas del metacódigo, como ...
Comparar y contrastar los ligeros lenguajes de marcado [cerrado]
Identifique los lenguajes de marcado ligeros más populares y compare sus fortalezas y debilidades. Estos lenguajes deberían ser marcas de uso general para la prosa técnica, como para la documentación (por ejemplo, Haml no cuenta). Ver ...
Rutinas intrínsecas indocumentadas [cerrado]
Delphi tiene esta lista:Rutinas intrínsecas de Delphi [http://docwiki.embarcadero.com/RADStudio/XE8/en/Delphi_Intrinsic_Routines] Pero esa lista está incompleta. ¿Qué funciones intrínsecas indocumentadas existen, desde cuándo y cuál es su propósito?
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 ...
Se puede utilizar LaTeX para producir cualquier documentación que acompañe al software? [cerrado
Aunque está relacionado conesta pregunta sobre el uso de LaTeX fuera de las matemáticas y la academia [https://stackoverflow.com/questions/39029/is-latex-used-outside-mathematics-and-academia] , Me pregunto específicamente si alguien usa o está ...
La esfinge ha reportado enlaces rotos.
Al crear la documentación html, ¿cómo obliga a la esfinge a informar o crear un error en los enlaces que no existen?Específicamente, tengo propiedades y méto...
Sphinx y argparse - autodocumentar los scripts de línea de comandos?
Estoy creando un paquete de Python y usando Sphinx para crear los documentos. Aparte de mi código de paquete, también incluyo muchos scripts de Python de lín...
¿Es necesario exportar extensiones de método base en un paquete R? ¿Implicaciones de documentación?
En principio, podría mantener estas extensiones no exportadas, y esto también me permitiría no agregar documentación redundante para estos métodos ya bien documentados, al mismo tiempo que también pasabaR CMD check myPackage sin ningún @ ...
Documentación API RESTful [cerrado]
Pronto voy a diseñar una API REST, por lo que debo describirla para que otras personas puedan comenzar a implementar los clientes que la utilizan.He mirado a...