Un fragmento sin contexto se convierte en un ejercicio de adivinanzas. Quizás recuerdes por qué lo guardaste hoy, pero seis meses después, la entrada, dependencia o suposición que falta puede importar más que el código en sí.

Guarde el problema con la solución.

Asigne a la nota un título descriptivo y explique qué hace el fragmento. Registre el idioma, la versión relevante y cualquier dependencia. Incluya la entrada de ejemplo más pequeña y el resultado que esperaba cuando la probó.

Si el fragmento proviene de una fuente, conserve el enlace de la fuente y verifique los términos para su reutilización. No elimine la atribución simplemente porque el fragmento es corto. Mantenga los secretos, los datos reales de los clientes y las credenciales específicas del entorno fuera del ejemplo guardado.

Explicar los supuestos

Indique qué entradas acepta el código y cuáles no. Tenga en cuenta si cambia archivos, llama a un servicio o necesita permisos. Un comando que parece un atajo conveniente puede tener un efecto muy diferente en otro directorio.

Utilice un bloque de código vallado con una etiqueta de idioma donde su renderizador Markdown lo admita. El editor de proyectos de MeatPad puede mantener la nota junto a los archivos fuente relacionados. El resaltado de sintaxis ayuda a la lectura; no establece que el fragmento sea correcto.

Vuelva a comprobar antes de reutilizar

Ejecute el fragmento con un ejemplo pequeño y no crítico en el entorno donde planea usarlo. Compare el resultado con la expectativa guardada. Las dependencias y las API pueden cambiar después de escribir la nota.

Agregue una fecha de última verificación cuando el fragmento pase a formar parte de un flujo de trabajo repetido. Si su contexto se ha convertido en un programa completo, promuévalo a un guión mantenido en lugar de acumular correcciones en una nota. El fragmento útil es el que puedes explicar y probar, no simplemente el que puedes pegar.

Fuentes y detalles del producto.

Comience con una nota. MeatPad proporciona notas, Markdown y archivos de proyecto en un espacio de trabajo local en tu Mac, sin necesidad de tener una cuenta.

Explorar MeatPad →