Comentarios útiles para código existente

Prompt para comentarios útiles y descripciones de funciones en código existente, sin cambiar la lógica ni los nombres. Cópielo en la herramienta de IA que prefiera, que luego comenta el código.

Tema: Entender código
Tipo: Prompt
Nivel: Principiante
Tiempo: aprox. 5 min

Los resultados dependen de la herramienta, del modelo y de lo que escriba.

Vista previa del resultado

Ejemplo: escrito por nuestra redacción, no es una respuesta real de IA.

def precio_neto(bruto, tipo): """Convierte un precio bruto en precio neto. bruto: precio con impuestos, como decimal. tipo: tipo impositivo como fracción, p. ej. 0.21. Devuelve el precio neto redondeado a dos decimales. """ # Redondear solo al final para que no se sumen errores de redondeo. return round(bruto / (1 + tipo), 2) Comprobar: ¿qué pasa si tipo = -1?

Rellenar

Lo que escriba se queda en esta ventana del navegador. No guardamos ni enviamos nada.

Lenguaje¿En qué lenguaje está el código?

Lector¿Quién leerá el código después?

CódigoPegue el código, sin claves ni datos de clientes

Su prompt

Escribe comentarios útiles y descripciones de funciones para el siguiente código.
Lenguaje: [Lenguaje]
Quién leerá el código después: [Lector]
Código:
<code>
[Código]
</code>
Reglas: 1. Describe cada función en una a tres frases: qué hace, qué entradas espera y qué devuelve. 2. En el código, comenta solo los puntos donde el porqué no es evidente. 3. No repitas lo que el código ya dice. 4. Marca las suposiciones y casos límite que notes con «Comprobar:». 5. No cambies la lógica ni los nombres. Usa el estilo de comentarios habitual del lenguaje. Devuelve el código comentado y debajo una lista de los puntos a comprobar.

Pon especial atención en explicar el porqué en lugar de repetir el código y no cambiar ni la lógica ni los nombres.

Antes de responder, comprueba: ¿se cumplen todas las indicaciones? Si falta un dato importante o aún queda un marcador entre corchetes, pregunta en lugar de adivinar. Señala las suposiciones como tales.

Esto es una instrucción para una IA, todavía no el resultado.

Dónde funciona este prompt

Estas herramientas de IA encajan bien con este prompt:

Cómo usarlo

Rellene los campos o toque una sugerencia. No incluya nombres, direcciones ni otros datos personales.
Copie el prompt terminado en la herramienta de IA que prefiera.
Revise los comentarios y aclare los puntos a comprobar antes de adoptarlos.

¿Por qué funciona?

Los comentarios que explican el porqué siguen siendo útiles tras los cambios. La regla de no tocar la lógica mantiene el cambio pequeño y fácil de revisar.

Consejos

Quite antes de pegar valores sensibles como claves o contraseñas, o sustitúyalos por marcadores.

Puede usar nuestros prompts libremente, también en el trabajo. No las publique como colección propia. No damos garantía sobre los resultados de la IA; revíselos usted. Condiciones de uso

Comentarios útiles para código existente

Vista previa del resultado

Rellenar

Su prompt

Dónde funciona este prompt

Cómo usarlo

¿Por qué funciona?

Consejos

También le puede servir

Que le expliquen código desconocido Nuevo

Dividir un cambio grande en commits revisables Nuevo

Programación cron a partir de una descripción Nuevo