In einem früheren Blogbeitrag haben wir Ihnen gezeigt, dass die Dokumentation für Methoden in den Explorer zurückgekehrt ist. Möchten Sie noch einen Schritt weiter gehen und sie als Dokumentation für Ihre Komponenten verwenden? In diesem Blogbeitrag zeigen wir Ihnen, wie das geht!
Freigeben von Quellcode und Dokumentation
Die gemeinsame Nutzung von Komponentenquellen mit Projektdatenbanken ist sehr einfach(z. B. über GitHub). Um zu erklären, wie man sie benutzt, ist die Dokumentation unerlässlich. Die Dokumentation im Explorer wird in Markdown-Dateien gespeichert, so dass Sie sie zur Erstellung von Dokumentationen für Ihre Komponenten verwenden können.
Wenn Sie GitHub verwenden, können Sie eine Mini-Site für Ihre Dokumentation erstellen. Erstellen Sie einfach eine README-Datei mit einem Link zur Dokumentation der einzelnen Methoden. Aktivieren Sie dann in Ihren Repository-Einstellungen die GitHub-Seite.
Voilà!
README.md
getStartOfMonth.md
Kompilierte Komponente UND DOKUMENTATION
Wenn Sie Ihre Komponente oder kompilierte Anwendung mit dem Dialogfeld „Anwendung erstellen“ kompilieren, wird der Ordner „Dokumentation“ automatisch in den endgültigen Projektordner kopiert.
Projekt
Kompilierte Komponente
Wenn ein Entwickler Ihre Komponente in seine Datenbank einbindet, kann er die Dokumentation direkt im Explorer in 4D sehen.