Durante lo sviluppo di un’applicazione, può essere molto utile avere un accesso rapido ai dettagli di un metodo(ad esempio, una spiegazione di ciò che fa, la sua sintassi e la definizione dei parametri che gli vengono passati). Questo diventa ancora più importante quando si usa un componente compilato. Non potendo guardare il contenuto del metodo, si può fare affidamento solo sulla sua documentazione per capire come usarlo.
La finestra di dialogo di Explorer è stata migliorata e la documentazione è ora disponibile in 4D v18 R3 per i database di progetto.
La documentazione viene salvata in un file con lo stesso nome del metodo o del modulo in una cartella di documentazione. Il nuovo formato della documentazione è Markdown.
Perché Markdown?
Il linguaggio Markdown consente di formattare il testo e ha una sintassi molto semplice. In questo modo, il documento è facile da leggere e scrivere, senza interrompere la sua interpretazione.
Molti strumenti utilizzano Markdown per la formattazione della documentazione. Ad esempio, GitHub fornisce un interprete Markdown integrato.
Documentazione in 4D
La documentazione è disponibile per:
- Metodi di progetto
- Metodi del database
- Metodi di trigger
- Metodi dei moduli di progetto
- Metodi del modulo tabella
- Classi
Quando si esporta il database binario come progetto, la documentazione esistente viene salvata in file in formato Markdown.
Per creare o modificare il file di documentazione in un database di progetto, fare clic sul pulsante “Crea” o selezionare la voce di menu “Modifica documentazione” nell’Explorer.
4D crea il file corrispondente e lo apre nell’editor predefinito. Il file include un modello:
<!-- Type your summary here --> ## Description ## Example ```4d Type your example here ```
Si può notare che la prima riga utilizza i tag di commento HTML. Questa informazione viene visualizzata nell’editor del metodo quando si passa il cursore su di esso. Il resto del file viene visualizzato nella scheda “Documentazione” dell’explorer.
Esempio
Se utilizziamo il metodo getWeekday come esempio, ecco il risultato:
In un prossimo post del blog, vi mostreremo come utilizzare i commenti per scrivere la vostra documentazione per i componenti. Restate sintonizzati!