documentation

5El calor

1Respuesta

Advertencia en el patio con la etiqueta @param

yo estaba tratando de documentar algunas código Ruby usando yard y aunque yo estoy haciendo exactamente lo que se describe here o here # @param [Integer] the number of trials (>= 0) # @param [Float]

ruby documentation yard 2012-07-03

---

21El calor

3Respuesta

Multiline Clojure docstrings

Me he dado cuenta de que las cadenas multilínea Clojure parecen formatearse manualmente en la mayoría de los casos, incluidas las de clojure.core. Ejemplo de https://github.com/clojure/clojure/blob/ma

clojure documentation docstring 2012-05-23

---

10El calor

1Respuesta

Omitir (o formatear) el valor de una variable al documentar con Sphinx

Actualmente estoy documentando un módulo completo con autodoc. Sin embargo, defino varias variables en el nivel de módulo que contienen largas listas o dicts. Se incluyen en la documentación junto con

python documentation python-sphinx 2012-06-02

---

22El calor

3Respuesta

Sphinx y argparse - autodocumentación de scripts de línea de comando?

Estoy compilando un paquete de Python y utilizando Sphinx para crear los documentos. Aparte de mi código de paquete, también incluyo una gran cantidad de scripts de Python de línea de comando, que usa

python documentation python-sphinx argparse 2012-06-04

---

65El calor

4Respuesta

¿Cómo leer la documentación de API para newbs?

Estoy leyendo a través de la guía de scripts de JavaScript para Photoshop, Illustrator e InDesign. La API es realmente difícil de leer porque supone que sé ciertas convenciones de taquigrafía. El prob

api documentation 2012-06-07

---

5El calor

3Respuesta

Sandcastle no documenta los resúmenes de propiedad

Estoy utilizando SandCastle con la GUI de HelpBuilder por primera vez hoy para ayudar a crear una API de algunas de nuestras funciones y propiedades expuestas. He incluido /// <summary> ... </summary

c# documentation sandcastle 2012-06-07

---

47El calor

7Respuesta

¿Hay alguna alternativa real a reStructuredText para la documentación de Python?

Estoy comenzando un proyecto de código abierto de Python en breve y estoy tratando de decidir de antemano cómo escribir mis documentos. La respuesta obvia sería usar reStructuredText y Sphinx con auto

python documentation python-sphinx restructuredtext docstring 2012-06-22

---

29El calor

3Respuesta

¿Cómo hago referencia a un parámetro de función de Python documentado usando el marcado Sphinx?

Me gustaría hacer referencia a un parámetro de función previamente documentado en otro lugar en una docstring de Python. Considere el (la verdad es completamente artificial) siguiente ejemplo: def foo

python documentation python-sphinx docstring 2012-06-23

---

14El calor

2Respuesta

Dónde definir el número de versión de la aplicación Rails

¿Existe alguna convención sobre cómo/dónde especificar el número de versión de la aplicación? Por ejemplo, para las gemas de rubí lib/mygem/version.rb es el archivo generalmente utilizado para ese pro

ruby-on-rails ruby documentation versioning 2012-06-26

---

19El calor

4Respuesta

¿Hay alguna forma de generar una wiki de documentación para github a partir de los comentarios de mi documentación XML en C#?

Quiero generar documentación API para mi proyecto de código abierto en Github. Me gustaría crearlos automáticamente a partir de mis Comentarios de Documentación XML en mis proyectos de C#. Mi débil Go

visual-studio-2010 github documentation markdown wiki 2012-06-28

---