documentation

Actualmente estoy empezando con Python y tengo una sólida formación en PHP y en PHP he tomado la costumbre de usar javadoc co ... ame, '%priority%' : priority, '%message%' : message} return self.__pattern.format(**values)

Una de las nuevas características de Xcode 5 es la capacidad de documentar su propio código con una sintaxis de comentario e ... un subconjunto de esas características. ¿Qué comandos son compatibles y cuáles no? ¿Alguno de sus usos difiere de Doxygen?

Bien, así que he leído tanto PEP 8como PEP 257, y he escrito un montón de docstrings para funciones y clases, pero estoy un ... es, información de derechos de autor, etc. ¿Alguien tiene un ejemplo de cómo debe estructurarse un buen docstring de python?

Tengo un colega que insiste en que su código no necesita comentarios, es "auto-documentación." He revisado su código, y aunq ... itivos) de los evangelistas de código de auto-documentación. Espero que otros se downvote si usted no permanecer en el tema.

Así que entiendo completamente cómo usar remuestrear, pero la documentación no hace un buen trabajo explicando las opciones. ... resample y cómo las entradas? Si es así, donde porque no pude encontrarlo. Si no, ¿cuáles son todas las opciones para ellos?

¿Cómo documentar métodos con parámetros usando cadenas de documentación de Python? EDITAR: PEP 257 da este ejemplo: de ... ary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero ... Environement : Python 2.7.1

No puedo encontrar los documentos sin conexión para Android. ¿Puede alguien proporcionar un enlace?

Actualmente estoy escribiendo un pequeño framework que será utilizado internamente por otros desarrolladores dentro de la com ... ¿Debo documentar las excepciones lanzadas por File.Open()? ¿Cuál sería la mejor manera de documentar posibles excepciones?

El sentido común dice que los bloques de comentarios Doxygen tienen que ser puestos en los archivos de cabecera donde están l ... entarios no están en los archivos de cabecera donde están las declaraciones. Entonces, ¿qué piensas y posiblemente sugieres?

Me gusta que doxygen cree documentación de código C o PHP. Tengo un próximo proyecto de Python y creo recordar que Python no ... o con doxygen, ¿cómo puedo usarlo para producir mi documentación de Python? ¿Hay algo en particular que deba tener en cuenta?

Por favor, identifique los lenguajes de marcado ligero más populares y compare sus fortalezas y debilidades. Estos lenguajes ... la prosa técnica, como para la documentación (por ejemplo, Haml no cuenta). Ver también: Markdown versus reStructuredText

Actualización Ago 2015: Pinterest lo proporciona aquí ahora https://dev.pinterest.com / ¿Hay documentación oficial o no ... no oficial de Facebook tiene información de calidad y varias personas hacen preguntas y publican respuestas bastante útiles

¿Hay formas automáticas de sincronizar comentarios entre una interfaz y su implementación? Actualmente estoy documentando am ... fectamente la documentación en Sand Castle, pero no funciona en intellisense tooltips. Por favor comparta su idea. Gracias.

Estoy leyendo la guía de scripting JavaScript para Photoshop, Illustrator e InDesign. La API es muy difícil de leer porque as ... por qué la documentación de la API está escrita de tal manera que confunda a los novatos / hackers / DIYers perennes como yo?

Estoy usando sphinx y el plugin autodoc para generar documentación API para mis módulos Python. Si bien puedo ver cómo docu ... un ejemplo de cómo documentar un parámetro **kwargs. ¿Alguien tiene un buen ejemplo de una manera clara de documentar esto?

Comenzaré con un ejemplo. Aquí hay un equivalente de List.fill para tuplas como macro en Scala 2.10: import scala.language. ... ivel de método. Cualquier ejemplo o punteros serían apreciados, incluyendo los de otros idiomas con sistemas macro similares.

Esto es algo que me ha estado molestando por un tiempo. Cuando veo cualquier método Ruby impreso en texto, generalmente apar ... od ¿Por qué todos los métodos Ruby están precedidos por un signo de libra? ¿Hay alguna razón para ello? Sólo curiosidad.

Actualmente estoy usando JSDoc Toolkit para documentar mi código, pero no encaja del todo, es decir, parece tener dificultad ... jor con Node.js? (Miré brevemente en Natural Docs, JSDuck y breezed sobre bastantes otros que parecían bastante obsoletos...)

La ayuda para Mogenerator es muy mínima. ¿Qué hacen todos los parámetros?

He oído que la interfaz de usuario de jQuery incluye un selector de color, pero podría encontrar poca documentación al respec ... cker(); no es un método! Parece funcionar bien, a menos que lo ponga en una interfaz de diálogo donde luego decida romperse.