Bases de données du projet : Créez votre propre documentation pour les composants

Traduit automatiquement de Deepl

Dans un précédent billet de blog, nous vous avons montré que la documentation des méthodes est revenue dans l’Explorateur. Vous voulez aller encore plus loin et les utiliser comme documentation pour vos composants ? Dans ce billet de blog, nous allons vous montrer comment faire !

Partager le code source et la documentation

Le partage des sources des composants avec les bases de données du projet est très facile(par exemple, via GitHub). Pour expliquer comment les utiliser, la documentation est essentielle. La documentation de l’explorateur est enregistrée dans des fichiers Markdown, vous pouvez donc l’utiliser pour créer de la documentation pour vos composants.

Si vous utilisez GitHub, vous pouvez créer un mini-site pour votre documentation. Il suffit de créer un fichier README contenant un lien vers la documentation de chaque méthode. Puis, dans les paramètres de votre dépôt, activez la page GitHub.

blank

Voilà !

README.md

blank

getStartOfMonth.md

blank

Composant compilé ET DOCUMENTATION

Lorsque vous construisez votre composant ou votre application compilée avec la boîte de dialogue « Build Application », le dossier « Documentation » est automatiquement copié dans le dossier final du projet.

Projet

blank

Composant compilé

blank

Lorsqu’un développeur intègre votre composant dans sa base de données, il peut directement voir la documentation dans l’explorateur de 4D.

blank

Vanessa Talbot
- Product Owner -Vanessa Talbot a rejoint l'équipe du programme 4D en juin 2014. En tant que Product Owner, elle est chargée de rédiger les user stories puis de les traduire en spécifications fonctionnelles. Son rôle est également de s'assurer que l'implémentation des fonctionnalités livrées répond aux besoins des clients.Depuis son arrivée, elle a travaillé à la définition des fonctionnalités clés de 4D. Elle a travaillé sur la plupart des nouvelles fonctionnalités de multithreading préemptif et aussi sur un sujet très complexe : la nouvelle architecture pour les applications enginées. Vanessa est diplômée de Telecom Saint-Etienne. Elle a commencé sa carrière à l'Institut de Recherche Criminelle en tant que développeur pour le département audiovisuel. Elle a également travaillé dans les domaines des médias et du médical en tant qu'experte en support technique, en production ainsi qu'en documentation de nouvelles fonctionnalités.