In un precedente post del blog, vi abbiamo mostrato che la documentazione dei metodi è tornata nell’Explorer. Volete andare oltre e usarli come documentazione per i vostri componenti? In questo post vi mostreremo come fare!
Condividere il codice sorgente e la documentazione
Condividere i sorgenti dei componenti con i database dei progetti è molto semplice(ad esempio, tramite GitHub). Per spiegare come utilizzarli, la documentazione è essenziale. La documentazione di Explorer è salvata in file Markdown, quindi potete usarla per creare la documentazione dei vostri componenti.
Se si usa GitHub, si può creare un mini-sito per la documentazione. È sufficiente creare un file README con un link alla documentazione di ogni metodo. Quindi, nelle impostazioni del repository, attivare la pagina GitHub.
Voilà!
README.md
getStartOfMonth.md
Componente compilato E DOCUMENTAZIONE
Quando si costruisce il componente o l’applicazione compilata con la finestra di dialogo “Build Application”, la cartella “Documentation” viene copiata automaticamente nella cartella finale del progetto.
Progetto
Componente compilato
Quando uno sviluppatore integra il vostro componente nel suo database, può vedere direttamente la documentazione nell’Explorer di 4D.