Často kladené otázky
Otázky:
Odpovědi:
Kde mají být komentáře tříd, vlastností, metod a procedur?
Komentář třídy, vlastností, metod a procedur se musí vždy nacházet na programovém řádku vlastní definice třídy/vlastnosti/metody/procedury. Komentář může být víceřádkový, nebo může začínat až na dalším řádku pokud je použit oddělovač ";" .Následující ukázka zobrazuje možné varianty.
PROCEDURE Proc_A(loPar) && Komentář procedury (jeden řádek)
RETURN
ENDPROC
PROCEDURE Proc_B(loPar) && Komentář procedury (dva řádky) ;
&& Druhý řádek
RETURN
ENDPROC
PROCEDURE Proc_C(loPar) && Komentář procedury (dva řádky) ;
Druhý řádek
RETURN
ENDPROC
PROCEDURE Proc_D(loPar);
&& Komentář procedury (jeden řádek)
RETURN
ENDPROC
PROCEDURE Proc_E(; && Komentář procedury (tři řádky)
loPar); && Druhý řádek
&& Třetí řádek
RETURN
ENDPROC
DEFINE CLASS _myClass AS custom && Komentář třídy ;
Druhý řádek
MyProp_A ="aaa" && Komentář vlastnosti
MyProp_B ="aaa" ;
&& Komentář vlastnosti
MyProp_C ="aaa" ; && Komentář vlastnosti (dva řádky)
&& Druhý řádek
MyProp_D ; && Komentář vlastnosti (tři řádky)
="aaa" ; && Druhý řádek
&& Třetí řádek
* Metody jsou stejné jako procedury
ENDDEFINE
Co je to detailní popis metod a procedur?
Metody a procedury (obecně zdrojový kód, tedy i počáteční kód programů) mohou mít vlastní detailní popis, který může být vložen do výsledné HTML dokumentace.
Tento detailní popis může být rozdělen do více částí a je vždy při zpracování vyjmut ze zdrojového kódu a zobrazen zvlášť.
Začátek a konec detailního popisu je uvozen řetězcem v poznámce jejichž definice se provádí ve formuláři "Další nastavení" na kartě "Popis".
Tato identifikace může být kdekoliv ve zdrojovém kódu metody/procedury, avšak nesmí na stejném řádku jako výkonný kód.
V následující ukázce je začátek detailního popisu uvozen řetězcem DOCUMENT_START a konec DOCUMENT_STOP:
PROCEDURE Test(lcValue) && Testing procedure
NOTE DOCUMENT_START
* Toto je detailní popis
NOTE DOCUMENT_STOP
lcValue=lcValue+REPL("X",10)
NOTE DOCUMENT_START
* A další detailní popis
NOTE DOCUMENT_STOP
ENDPROC
Co je to "Řízená dokumentace"?
Řízená dokumentace je možnost zvolit, zda má být zdrojový kód či detailní popis součástí výsledné HTML dokumentace.
Ve formuláři "Další nastavení" na kartě "Zdrojový kód" jsou čtyři volby (pro detailní popis se toto nastavuje na kartě "Popis" ):
Vlastní - Vložení či nevložení se řídí nastaveními na jednotlivých stránkách. Volby jsou:
Vložit - Bude vložen.
Nevložit - Nebude vložen.
Označené - Vloženy pouze označené.
Vždy vložit - Zdrojový kód (či detailní popis) bude vždy vložen do výsledné HTML dokumentace.
Vždy nevložit - Zdrojový kód (či detailní popis) nebude nikdy vložen do výsledné HTML dokumentace.
Pouze označené - Zdrojový kód (či detailní popis), který bude označen, bude vložen do výsledné HTML dokumentace. Příznak zahrnutí do HTML dokumentace je uvozen řetězcem v poznámce, který se definuje v poli vedle této volby.
Tato identifikace může být kdekoliv ve zdrojovém kódu metody/procedury, avšak nesmí na stejném řádku jako výkonný kód.
V následující ukázce je příznak vložení zdrojového kódu reprezentován řetězcem SOURCE_YES a detailního popisu DOCUMENT_YES:
PROCEDURE Test2(lcValue) && Second testing procedure
NOTE SOURCE_YES
NOTE DOCUMENT_START
* Toto je detailní popis
NOTE DOCUMENT_STOP
lcValue=lcValue+REPL("X",10)
NOTE DOCUMENT_YES
ENDPROC
Jak spustit PDM ze zdrojových kódů
DO [root_pdm\]setsenv.prg
DO go
Jak vytvořit distribuci PDM
DO [root_pdm\]setsenv.prg
* Create Distribution - EXE without debug information
DO cdistr WITH 'N','c:\pdm_distr'