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.
Voilà !
README.md
getStartOfMonth.md
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
Composant compilé
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.