L'essentiel de Ruby on Rails

Documenter son projet

TESTEZ LINKEDIN LEARNING GRATUITEMENT ET SANS ENGAGEMENT

Tester maintenant Afficher tous les abonnements
Lorsque vous créez un projet, pensez aux développeurs susceptibles de travailler dessus plus tard. Prenez soin de documenter votre projet au format HTML.
03:06

Transcription

Savoir documenter son code est, extrêmement, important pour assurer une pérennité au projet. En effet, si jamais vous revenez dessus plusieurs mois plus tard, vous risquez de ne plus comprendre ce que vous avez écrit au sein de votre code. Aussi, ajouter des commentaires à l’intérieur du code est, non seulement, utile pour tout autre développeur, qui viendrait sur votre projet, mais vous sera, également,utile pour vous, pour votre futur vous. En Ruby on Rails, nous utilisons la gemme RDoc, qui est intégrée, par défaut, dans le framework. Vous pourrez retrouver une documentation sur cette gemme sur les guides officiels de Ruby on Rails. Vous pouvez, également, faire un tour sur le dépôt de la gemme sur GitHub. Je vous montre, ici, un exemple de ce que vous pourriez avoir comme commentaire pour documenter votre application. Le formalisme de RDoc, lui est, également, spécifique. Vous avez toujours la possibilité d’utiliser markdown, si jamais vous le souhaitez. J’ai, par exemple, utilisé ici, RDoc et affiché, ici, un titre une liste de paramètres et un autre titre. Pour la documentation, vous pouvez être, plus ou moins, verbeux selon le temps que vous voulez y consacrer, évidemment, mais aussi, selon l’utilité de vos commentaires. N’écrivez pas, non plus, des choses qui seraient inutiles ou évidentes, par la simple lecture de votre code. Ici, j’ai, par exemple, décrit que la méthode get_answers va, automatiquement, filtrer les réponses du sujet de discussion pour les utilisateurs anonymes. J’ai spécifié, également, la liste des paramètres que cette méthode peut prendre et fourni deux exemples d’utilisation. Une fois que vous avez ajouté les commentaires au sein de vos fichiers, vous pouvez exécuter cette commande qui placera l’ensemble des fichiers de documentation en format HTML dans le dossier doc/app_doc. L’exécution de cette commande peut prendre un petit peu de temps. Une fois qu’elle sera terminée, vous aurez accès à l’ensemble de ces fichiers au sein de votre dossier doc/app_doc. Par défaut, la commande place ces fichiers dans le dossier doc. Mais, comme là, j’y ai des énoncés d’exercices, il a fallu que je lui donne une option pour les placer dans le dossier app_doc. Vous pouvez, ensuite, ouvrir n’importe quel fichier et vous arriverez sur une page similaire à celle-ci. Par exemple, là, j’ai ouvert la page d’index. Ensuite, je peux rechercher la classe Topic que j’ai commenté tout à l’heure, convenablement. Vous retrouvez du coup, ici, la documentation que j’ai mise à l’intérieur du fichier de notre modèle. Par exemple, nous avons l’ensemble de la documentation pour la méthode get_answers. Vous voyez comme, ici, elle est bien référencée. Cela peut être, directement, utilisé comme documentation pour votre application. Vous avez, également, le moyen d’afficher le code de la méthode. Vous pouvez même accéder à des fichiers javascript dans lesquels vous auriez mis, également, de la documentation. Cette vidéo vous a présenté comment ajouter un peu de documentation au sein de votre projet. N’hésitez pas à ajouter autant de commentaires que vous le souhaitez en suivant le formalisme RDoc pour obtenir une documentation maintenue et maintenable qui permettra de pérenniser votre application.

L'essentiel de Ruby on Rails

Concevez des applications web évolutives et intemporelles avec Ruby on Rails. Installez l’environnement, réalisez un projet de stack overflow, enrichissez-le, etc.

6h08 (85 vidéos)
Aucun commentaire n´est disponible actuellement

Votre formation est disponible en ligne avec option de téléchargement. Bonne nouvelle : vous ne devez pas choisir entre les deux. Dès que vous achetez une formation, vous disposez des deux options de consultation !

Le téléchargement vous permet de consulter la formation hors ligne et offre une interface plus conviviale. Si vous travaillez sur différents ordinateurs ou que vous ne voulez pas regarder la formation en une seule fois, connectez-vous sur cette page pour consulter en ligne les vidéos de la formation. Nous vous souhaitons un excellent apprentissage avec cette formation vidéo.

N'hésitez pas à nous contacter si vous avez des questions !