Při vývoji aplikace může být velmi užitečné mít rychlý přístup k podrobnostem metody(např. vysvětlení, co metoda dělá, její syntaxe a definice parametrů, které se jí předávají). To se stává ještě důležitějším při použití zkompilované komponenty. Nemůžete se podívat na obsah metody, takže se můžete spolehnout pouze na její dokumentaci, abyste pochopili, jak ji použít.
Dialogové okno Průzkumníka bylo vylepšeno a dokumentace je nyní k dispozici ve verzi 4D v18 R3 pro databáze projektů.
Dokumentace je uložena v souboru se stejným názvem jako metoda nebo formulář ve složce dokumentace. Nový formát dokumentace je Markdown.
Proč právě markdown?
Jazyk Markdown umožňuje formátovat text a má velmi jednoduchou syntaxi. Dokument se tak snadno čte a píše, aniž by se narušovala jeho interpretace.
Mnoho nástrojů používá k formátování dokumentace jazyk Markdown. Například GitHub poskytuje vestavěný interpret Markdown.
Dokumentace ve 4D
Dokumentace je k dispozici pro:
- Metody projektu
- Metody databáze
- Metody spouštěče
- Metody projektového formuláře
- Metody tabulkového formuláře
- Třídy
Při exportu binární databáze jako projektu se stávající dokumentace uloží do souborů ve formátu Markdown.
Chcete-li vytvořit nebo upravit soubor s dokumentací v databázi projektu, klikněte na tlačítko „Vytvořit“ nebo v Průzkumníku vyberte položku nabídky „Upravit dokumentaci“.
4D vytvoří příslušný soubor a otevře jej ve vašem výchozím editoru. Soubor obsahuje šablonu:
<!-- Type your summary here --> ## Description ## Example ```4d Type your example here ```
Vidíte, že na prvním řádku jsou použity značky komentářů HTML. Tato informace se zobrazí v editoru metody, když na ni najedete kurzorem. Zbytek souboru se zobrazí na kartě „Dokumentace“ v průzkumníku.
Příklad:
Použijeme-li jako příklad metodu getWeekday, zde je výsledek:
V některém z příštích příspěvků na blogu si ukážeme, jak využít komentáře k psaní vlastní dokumentace komponent. Zůstaňte naladěni!