Bases de données du projet : La documentation des méthodes est de retour

Lors du développement d’une application, il peut être très utile d’avoir un accès rapide aux détails d’une méthode(par exemple, une explication de ce qu’elle fait, sa syntaxe et une définition des paramètres qui lui sont passés). Cela devient encore plus important lorsque vous utilisez un composant compilé. Vous ne pouvez pas voir le contenu de la méthode, vous ne pouvez donc vous fier qu’à sa documentation pour comprendre comment l’utiliser.

La boîte de dialogue de l’explorateur a été améliorée et la documentation est désormais disponible dans 4D v18 R3 pour les bases de données de projet.

La documentation est enregistrée dans un fichier portant le même nom que la méthode ou le formulaire dans un dossier de documentation. Le nouveau format de la documentation est Markdown.

Pourquoi Markdown ?

Le langage Markdown permet de mettre en forme du texte et possède une syntaxe très simple. Ainsi, le document est facile à lire et à écrire, sans interrompre son interprétation.
De nombreux outils utilisent Markdown pour mettre en forme la documentation. Par exemple, GitHub fournit un interprète Markdown intégré.

Documentation dans 4D

La documentation est disponible pour :

• les méthodes de projet
• Méthodes de base de données
• Méthodes de déclenchement
• Méthodes des formulaires de projet
• Méthodes du formulaire de table
• Classes

Lorsque vous exportez votre base de données binaire en tant que projet, votre documentation existante est enregistrée dans des fichiers au format Markdown.

Pour créer ou modifier le fichier de documentation d’une base de données de projet, cliquez sur le bouton « Créer » ou sélectionnez l’élément de menu « Modifier la documentation » dans l’explorateur.

4D crée le fichier correspondant et l’ouvre dans votre éditeur par défaut. Le fichier comprend un modèle :

<!-- Type your summary here -->
## Description

## Example

```4d
Type your example here
```

Vous pouvez voir que la première ligne utilise les balises de commentaire HTML. Cette information est affichée dans l’éditeur de méthode lorsque vous passez le curseur sur la méthode. Le reste du fichier est affiché dans l’onglet « Documentation » de l’explorateur.

Exemple

Si nous utilisons la méthode getWeekday comme exemple, voici le résultat :

Dans un prochain article de blog, nous vous montrerons comment utiliser les commentaires pour écrire votre propre documentation pour les composants. Restez à l’écoute !