Projekt-Datenbanken: Die Methodendokumentation ist zurück

Bei der Entwicklung einer Anwendung kann es sehr nützlich sein, schnell auf die Details einer Methode zugreifen zu können(z. B. eine Erläuterung ihrer Funktion, ihrer Syntax und eine Definition der an sie übergebenen Parameter). Dies wird noch wichtiger, wenn man eine kompilierte Komponente verwendet. Sie können sich den Inhalt der Methode nicht ansehen und können sich daher nur auf die Dokumentation verlassen, um zu verstehen, wie sie zu verwenden ist.

Der Dialog des Explorers wurde verbessert und die Dokumentation ist jetzt in 4D v18 R3 für Projektdatenbanken verfügbar.

Die Dokumentation wird in einer Datei mit dem gleichen Namen wie die Methode oder das Formular in einem Dokumentationsordner gespeichert. Das neue Format für die Dokumentation ist Markdown.

Warum Markdown?

Die Sprache Markdown ermöglicht es Ihnen, Text zu formatieren und hat eine sehr einfache Syntax. Dadurch ist das Dokument leicht zu lesen und zu schreiben, ohne die Interpretation zu unterbrechen.
Viele Tools verwenden Markdown für die Formatierung der Dokumentation. GitHub bietet zum Beispiel einen integrierten Markdown-Interpreter.

Dokumentation in 4D

Dokumentation ist verfügbar für:

  • Projektmethoden
  • Datenbank-Methoden
  • Auslöser-Methoden
  • Projektformular-Methoden
  • Methoden für Tabellenformulare
  • Klassen

Wenn Sie Ihre binäre Datenbank als Projekt exportieren, wird Ihre bestehende Dokumentation in Dateien im Markdown-Format gespeichert.

Um die Dokumentationsdatei in einer Projektdatenbank zu erstellen oder zu bearbeiten, klicken Sie auf die Schaltfläche „Erstellen“ oder wählen Sie den Menüpunkt „Dokumentation bearbeiten“ im Explorer.

blank

4D erstellt die entsprechende Datei und öffnet sie in Ihrem Standard-Editor. Die Datei enthält eine Vorlage:

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

## Example

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

Sie können sehen, dass die erste Zeile die HTML-Kommentar-Tags verwendet. Diese Information wird im Methoden-Editor angezeigt, wenn Sie mit dem Mauszeiger über die Methode fahren. Der Rest der Datei wird auf der Registerkarte „Dokumentation“ des Explorers angezeigt.

Beispiel

Wenn wir die Methode getWeekday als Beispiel verwenden, sieht das Ergebnis folgendermaßen aus:

blank

In einem der nächsten Blog-Beiträge werden wir Ihnen zeigen, wie Sie die Kommentare nutzen können, um Ihre eigene Dokumentation für Komponenten zu schreiben. Bleiben Sie dran!

Vanessa Talbot
Product Owner - Vanessa Talbot kam im Juni 2014 zum 4D Programmteam. Als Product Owner ist sie für das Schreiben der User Stories und deren Umsetzung in funktionale Spezifikationen zuständig. Ihre Aufgabe ist es auch, sicherzustellen, dass die Implementierung der Funktionen den Anforderungen des Kunden entspricht. Seit ihrer Ankunft hat sie an der Definition der wichtigsten Funktionen in 4D gearbeitet. Sie hat an den meisten der neuen Funktionen für präemptives Multi-Threading gearbeitet und auch an einem sehr komplexen Thema: der neuen Architektur für erstellte Anwendungen. Vanessa hat einen Abschluss von der Telecom Saint-Etienne. Sie begann ihre Karriere am Criminal Research Institute als Entwicklerin für die audiovisuelle Abteilung. Sie hat auch in den Bereichen Medien und Medizin als Expertin für technischen Support, Produktion und die Dokumentation neuer Funktionen gearbeitet.