Un extrait sans contexte devient un exercice de devinette. Vous vous souvenez peut-être pourquoi vous l'avez enregistré aujourd'hui, mais six mois plus tard, l'entrée, la dépendance ou l'hypothèse manquante peut avoir plus d'importance que le code lui-même.

Enregistrez le problème avec la solution

Donnez à la note un titre descriptif et expliquez ce que fait l'extrait. Enregistrez la langue, la version pertinente et toutes les dépendances. Incluez le plus petit exemple d’entrée et le résultat auquel vous vous attendiez lorsque vous l’avez testé.

Si l'extrait provient d'une source, conservez le lien source et vérifiez les conditions de réutilisation. Ne supprimez pas l’attribution simplement parce que le fragment est court. Gardez les secrets, les données client réelles et les informations d'identification spécifiques à l'environnement hors de l'exemple enregistré.

Expliquer les hypothèses

Indiquez quelles entrées le code accepte et lesquelles il n'accepte pas. Notez s'il modifie des fichiers, appelle un service ou a besoin d'autorisations. Une commande qui ressemble à un raccourci pratique peut avoir un effet très différent dans un autre répertoire.

Utilisez un bloc de code clôturé avec une étiquette de langue là où votre moteur de rendu Markdown le prend en charge. L'éditeur de projet de MeatPad peut conserver la note à côté des fichiers source associés. La coloration syntaxique facilite la lecture ; cela ne prouve pas que l'extrait est correct.

Revérifier avant de réutiliser

Exécutez l'extrait de code sur un petit exemple non critique dans l'environnement dans lequel vous prévoyez de l'utiliser. Comparez le résultat avec l'attente enregistrée. Les dépendances et les API peuvent changer après la rédaction de la note.

Ajoutez une date de dernière vérification à laquelle le fragment fait partie d'un flux de travail répété. Si son contexte s'est développé en un programme complet, faites-en un script maintenu plutôt que d'accumuler des corrections dans une note. L'extrait utile est celui que vous pouvez expliquer et tester, pas seulement celui que vous pouvez coller.

Sources et détails du produit

Commencez par une note. MeatPad donne aux notes, Markdown et aux fichiers de projet un espace de travail local sur votre Mac, sans nécessiter de compte.

Explorez MeatPad →