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

Automaticky přeloženo z Deepl

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.

blank

Voilà!

README.md

blank

getStartOfMonth.md

blank

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“.

Projekt

blank

Zkompilovaná komponenta

blank

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.

blank

Vanessa Talbot
• Product Owner • Vanessa Talbot se připojila k programovému týmu 4D v červnu 2014. Jako Product Owner má na starosti psaní uživatelských příběhů a jejich převod do funkčních specifikací. Její úlohou je také zajistit, aby implementovaná funkce odpovídala potřebám zákazníka. Od svého příchodu pracovala na definování klíčových prvků ve 4D. Pracovala na většině nových funkcí preemptivního multi-threadingu a také na velmi složitém tématu: nové architektuře pro enginované aplikace. Vanessa má titul z Telecom Saint-Etienne. Svou kariéru začala ve Výzkumném ústavu kriminalistickém jako vývojářka pro audiovizuální oddělení. Působila také v mediální a lékařské oblasti jako expertka na technickou podporu, produkci i dokumentaci novinek.