Notes de l’éditeur : Notes des utilisateurs :[Total : 0 Moyenne : 0] @media(min-width : 500px) { } @media(min-width : 800px) { }
Codeguide est un outil gratuit et open-source pour créer et afficher des guides de code. Il vous permet d’importer un référentiel GitHub, puis de mettre en évidence le code et de créer une explication pour celui-ci. Vous pouvez l’utiliser en tant qu’enseignant ou développeur senior pour laisser des notes et des explications à votre équipe ou à votre classe. Il vous donne un éditeur de code comme une interface où d’autres peuvent voir le code ainsi que le guide.
Dans le guide de code, vous pouvez également laisser un processus étape par étape pour configurer quelque chose ou exécuter quelque chose. Vous pouvez créer des guides pour des fichiers de code source spécifiques, puis les publier. Il vous donne une URL unique où le référentiel final avec guide peut être consulté. Bien que vous puissiez l’héberger vous-même, il existe une version hébergée que vous pouvez utiliser avec un forfait gratuit.
Le forfait gratuit de Codeguide vous permet de créer des guides publics illimités. Et vous pouvez également créer 3 guides privés gratuitement. Il vous suffit de vous connecter à l’aide de votre compte GitHub, puis de saisir l’URL de n’importe quel référentiel pour commencer.
Créez des guides de code pour l’ensemble du référentiel GitHub afin d’expliquer le code avec cet outil gratuit
Vous pouvez accéder à la page d’accueil principale de cet outil ici. Sur la page principale, vous verrez l’option d’importer un référentiel GitHub. Alors, entrez l’URL et laissez-la chercher le référentiel pour vous.
Il va maintenant ouvrir un éditeur de code comme l’interface utilisateur pour vous où vous pouvez voir tous les fichiers qu’il a importé depuis le référentiel GitHub. Maintenant, vous pouvez commencer à créer le guide.
Sélectionnez du code, puis une boîte apparaîtra en bas. Vous pouvez maintenant écrire l’explication du code ici, puis créer une étape. Répétez le même processus, puis continuez à ajouter d’autres étapes avec plus d’explications.
Il vous montrera toutes les étapes que vous avez créées sur le côté droit. Lorsque vous avez terminé, il vous suffit de publier les guides. Après avoir publié le guide, vous pouvez envoyer son lien à n’importe qui, et ils peuvent accéder à la base de code maintenant avec les guides et les explications que vous avez créés. C’est aussi simple que cela.
Il vous propose même un tableau de bord simple à partir duquel vous pouvez suivre tous les guides que vous avez créés jusqu’à présent. Alors, cliquez simplement sur votre profil, puis accédez au tableau de bord. Ici, il vous montrera tous les guides publics et privés que vous avez créés.
De cette façon, vous pouvez utiliser cet outil de programmation pour créer et publier un guide de code et une explication de code personnalisé. Afin de créer une explication de code, vous pouvez également vous aider d’un plugin VS Code que j’ai couvert il y a quelques jours. Vous pouvez générer une explication de code à l’aide de l’IA et la publier à l’aide de la plate-forme Codeguide.
Réflexions finales :
En tant qu’enseignant et instructeur ou même chef d’équipe dans certains travaux de codage, vous aura besoin d’outils comme celui-ci que j’ai mentionné ici. Parfois, il peut être un peu difficile de trouver le bon outil pour partager un code compréhensible et les commentaires ne suffisent pas. Pour ces scénarios, la plate-forme Codeguide est conçue. Je l’ai aimé pour sa simplicité et le fait qu’il soit open source. Allez essayer et dites-moi ce que vous en pensez.
