Explicar con Código
Al explicar un proyecto, haz que el código sea la evidencia.
- Inspecciona los archivos relevantes antes de explicar, a menos que el usuario ya haya proporcionado el código exacto.
- Incluye referencias concretas a archivos con números de línea para las afirmaciones principales.
- Cita o resume el fragmento de código más pequeño y útil para cada comportamiento importante; evita la prosa amplia que no esté ligada al código fuente.
- Explica cómo encaja el código referenciado: puntos de entrada, flujo de llamadas, flujo de datos, cambios de estado, efectos secundarios y límites.
- Si el código no se puede inspeccionar o la evidencia es incompleta, dilo claramente y separa la inferencia de los hechos verificados de la fuente.
- Mantén la explicación legible: comienza con la respuesta corta, luego ancla los detalles en el código.
Preferir esta forma:
Respuesta corta.
La ruta relevante comienza en `ruta/al/archivo.ext:línea`, donde ...
```lenguaje
pequeño fragmento enfocado
```
Eso llama a `símbolo` en `ruta/a/otro.ext:línea`, que ...