Frequently Asked Questions
Questions:
Ansvers:
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) && Comment of procedure (One line)
RETURN
ENDPROC
PROCEDURE Proc_B(loPar) && Comment of procedure (Two lines) ;
&& Second Line
RETURN
ENDPROC
PROCEDURE Proc_C(loPar) && Comment of procedure (Two lines) ;
Second Line
RETURN
ENDPROC
PROCEDURE Proc_D(loPar);
&& Comment of procedure (One line)
RETURN
ENDPROC
PROCEDURE Proc_E(; && Comment of procedure (Three lines)
loPar); && Second line
&& Third line
RETURN
ENDPROC
DEFINE CLASS _myClass AS custom && Comment of class ;
Second line
MyProp_A ="aaa" && Comment of property
MyProp_B ="aaa" ;
&& Comment of property
MyProp_C ="aaa" ; && Comment of property (Two lines)
&& Second line
MyProp_D ; && Comment of property (Third lines)
="aaa" ; && Second line
&& Third line
* Methods like as procedures
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 "Other settings" na kartě "Description".
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
* This is detail description
NOTE DOCUMENT_STOP
lcValue=lcValue+REPL("X",10)
NOTE DOCUMENT_START
* And next detail description
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 "Other settings" na kartě "Source Code" jsou čtyři volby (pro detailní popis se toto nastavuje na kartě "Description" ):
- User - Vložení či nevložení se řídí nastaveními na jednotlivých stránkách. Volby jsou:
- Include - Bude vložen.
- Exclude - Nebude vložen.
- Signed - Vloženy pouze označené.
- Always Include - Zdrojový kód (či detailní popis) bude vždy vložen do výsledné HTML dokumentace.
- Always Exclude - Zdrojový kód (či detailní popis) nebude nikdy vložen do výsledné HTML dokumentace.
- Only Signed - 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
* This is detail description
NOTE DOCUMENT_STOP
lcValue=lcValue+REPL("X",10)
NOTE DOCUMENT_YES
ENDPROC