Databáze projektů: Vytvořte si vlastní dokumentaci pro komponenty

V předchozím příspěvku na blogu jsme vám ukázali, že se do Průzkumníka vrátila dokumentace k metodám. Chcete jít ještě dál a použít je jako dokumentaci pro své komponenty? V tomto blogovém příspěvku vám ukážeme, jak na to!

Sdílení zdrojového kódu a dokumentace

Sdílení zdrojových kódů komponent s databázemi projektů je velmi snadné(např. , prostřednictvím služby GitHub). Pro vysvětlení jejich použití je nezbytná dokumentace. Dokumentace v Průzkumníku je uložena v souborech Markdown, takže ji můžete použít k vytvoření dokumentace ke svým komponentám.

Pokud používáte službu GitHub, můžete si pro dokumentaci vytvořit mini-stránku. Stačí vytvořit soubor README s odkazem na dokumentaci každé metody. Poté v nastavení úložiště aktivujte stránku GitHub.

Voilà!

Zkompilovaná komponenta A DOKUMENTACE

Při sestavování komponenty nebo zkompilované aplikace pomocí dialogového okna „Sestavit aplikaci“ se do konečné složky projektu automaticky zkopíruje složka „Dokumentace“.

Když vývojář integruje vaši komponentu do své databáze, může si dokumentaci prohlédnout přímo v Průzkumníku v aplikaci 4D.