Preguntas con etiqueta 'documentation'

10
respuestas

Cómo hacer que una base de código grande sea más fácil de entender para los nuevos programadores

Supongamos que estoy desarrollando un proyecto relativamente grande. Ya he documentado todas mis clases y funciones con Doxygen, sin embargo, tuve la idea de poner "notas del programador" en cada archivo de código fuente. La idea detrás de es...
hecha 01.08.2015 - 00:33
0
respuestas

Mi jefe quiere una explicación narrada en inglés línea por línea de nuestro código

Se me ha pedido específicamente que brinde línea por línea (o según corresponda, por ejemplo, imagen por imagen, etc.) explicación o comentario que mi jefe quiere poder leer y seguir. Dado que no es un programador, no puede seguir el código,...
hecha 24.10.2011 - 16:09
4
respuestas

¿Cuál es el número de teléfono equivalente a example.org?

RFC 2606 estándar reserva los nombres de dominio ejemplo. org , example.net y example.com para El propósito de ser utilizado como ejemplos en la documentación. ¿Cuál es el equivalente de un número de teléfono (incluido el código de paí...
hecha 07.08.2018 - 18:32
13
respuestas

¿Cuáles son ejemplos de comentarios que te dicen por qué en lugar de cómo o qué? [cerrado]

En primer lugar, en esta pregunta me gustaría mantenerme alejado de la polémica sobre si el comentario del código fuente es bueno o malo. Solo trato de entender más claramente lo que quiere decir la gente cuando hablan sobre comentarios que te d...
hecha 09.08.2013 - 08:51
12
respuestas

¿Debe usarse el historial de confirmación para transmitir información crítica a los desarrolladores?

Durante una reunión con respecto a la reversión de un SDK de terceros de la última versión, se observó que nuestros desarrolladores ya habían marcado en el historial de confirmación que no debía usarse la última versión. Algunos desarrollador...
hecha 29.07.2014 - 15:59
16
respuestas

¿Qué hay de malo con los comentarios que explican el código complejo?

Mucha gente afirma que "los comentarios deben explicar 'por qué', pero no 'cómo'". Otros dicen que "el código debe ser auto-documentado" y los comentarios deben ser escasos. Robert C. Martin afirma que (reformulado a mis propias palabras) a menu...
hecha 01.09.2014 - 02:28
17
respuestas

¿Los comentarios de TODO tienen sentido? [cerrado]

Estoy trabajando en un proyecto bastante grande y tengo la tarea de hacer algunas traducciones para él. Hubo un montón de etiquetas que no han sido traducidas y, mientras buscaba en el código, encontré este pequeño código //TODO translations...
hecha 11.11.2013 - 10:46
15
respuestas

Voy a renunciar a mi trabajo debido a nuestra plataforma: ¿cómo puedo dejar una explicación productiva de esto? [cerrado]

Estoy planeando dejar mi trabajo actual porque estamos obligados a usar Blub , con un marco de Blub empresarial y un servidor web de nivel Blub, en alojamiento compartido mediocre. Mis compañeros de trabajo son amables y mi jefe es el propietar...
hecha 31.03.2012 - 19:34
10
respuestas

¿Existe tal cosa como tener demasiadas funciones / métodos privados?

Entiendo la importancia de un código bien documentado. Pero también entiendo la importancia del código de autodocumentación . Cuanto más fácil sea leer visualmente una función particular, más rápido podremos avanzar durante el mantenimiento del...
hecha 14.02.2011 - 00:26
13
respuestas

¿Puede el código comentado ser una documentación valiosa?

Escribí el siguiente código: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_F...
hecha 11.03.2013 - 10:36