1. Introducere
În lumea C ++, există, de asemenea, mai multe generatoare automate de documentație; programele Microsoft SandCastle și Doxygen se numără printre liderii.
Am decis să verific cât de bine Doxygen poate documenta MQL5, care, de fapt, este un subset al C ++. În opinia mea, suportul pentru programarea orientată pe obiecte este un pas important în maturitatea MQL5, deoarece acum limba vă permite să creați biblioteci mari de clasă. Acest experiment a fost un succes și sper că documentația creată de programul Doxygen din codul MQL5 va fi foarte utilă.
2. Programul Doxygen
Programul Doxygen este un sistem pentru crearea automată a documentației open source în conformitate cu Licența publică generală GNU. Aceasta înseamnă că dezvoltarea sa a fost similară cu alte proiecte open source, cum ar fi Linux și Mozilla. Acesta poate fi descărcat și folosit gratuit, codul sursă al Doxygen este deschis tuturor. Programul a fost dezvoltat și îmbunătățit de mai mulți dezvoltatori.
2.1 Descărcarea Doxygen
Site-ul web al programului Doxygen este www.doxygen.org. Acolo puteți găsi pagina de descărcare și descărcați cea mai recentă versiune de Doxygen pentru Windows. La scrierea articolului a fost o versiune a doxygen-1.6.1, după cum se arată în Figura 1:
Figura 1. Încărcarea doxigenului
2.2 Configurarea și rularea doxigenului
Pentru a configura Doxygen, trebuie să faceți mici ajustări - să adăugați tipurile de fișiere * .mqh și * .mq5 și să activați generarea de ajutor HTML. Următoarele cinci fotografii detaliază procesul de configurare.
Primele patru capturi de ecran (Figura 2-5) - fila de opțiuni de setări "Expert":
Figura 2. Configurarea programului Doxygen - Wizard 1
Figura 3. Configurarea programului Doxygen - Expert 2
Figura 4. Configurarea programului Doxygen - Expert 3
Figura 5. Configurarea programului Doxygen - Expert 4
În cele din urmă, în opțiunile "Expert" din descrierea fișierelor de intrare, trebuie să adăugați fișiere cu extensiile .mqh și .mq5:
Fig. 6. Setarea doxygen - adăugați tipuri de fișiere mqh și mq5
Acum totul este gata. Rețineți că Doxgyen va salva setările în fișierul de configurare. Fișierul pregătit cu setările este atașat la articol.
Figura 7. Rularea doxigenului
2.3 Folosind Doxygen
Programul are un excelent ajutor Doxygen (creat, desigur, folosind Doxygen - aici versiunea originală în format HTML) care detaliază gama de caracteristici uimitoare, inclusiv vizualizare excelentă de formule matematice complexe. Cu toate acestea, Doxygen poate fi de asemenea folosit ca o modalitate ușoară de a crea fișiere de ajutor ușor de utilizat.
Ca un exemplu, ia în considerare CiMACD :: Creare) în funcția MQL5 (/ Include fișierul / Oscilators.mqh. Rețineți că descrierea indicatorilor de fișiere lipsesc în prima livrare a MetaTrader 5. Pentru a le primi, poate fi necesar să descărcați cea mai recentă versiune a MetaTrader 5.
După procesarea programului Doxygen, fișierul de ajutor va arăta așa cum se arată în Fig. 8:
Figura 8. Descrierea funcției CiMACD :: Create (), creată de Doxygen
2.4 Folosim Doxygen pentru a documenta tot codul furnizat cu MQL5
Puterea lui Doxygen este crearea de fișiere de ajutor pentru proiectele mari. Pachetul de livrare MetaTrader 5 (director MQL5) conține mai mult de o sută de fișiere .mq5 și .mqh, dintre care multe sunt legate între ele.
Pentru a crea ajutor pentru întregul cod MQL5 furnizat împreună cu MetaTrader, trebuie să faceți următoarele:
- Copiați conținutul directorului MQL5 împreună cu subdirectoarele în directorul MQL5 / fișiere.
- Ștergeți fișierul MQL5 / files / MQL5 / Include / Strings / string.mqh - pentru un motiv necunoscut, Doxygen nu poate interpreta corect.
Documentația rezultată este de bună calitate și demonstrează rapid utilitatea acesteia - exemplele sunt prezentate în Figura 9-12.
Figura 9. Lista claselor create de Doxygen
Figura 10. Diagrama descendenților clasei CArrayObj, creată de Doxygen
Fig. 11. Lista funcțiilor clasei CArrayObj, creată de Doxygen
Figura 12. Lista de definiții (definită) creată de Doxygen
3. Atelier de ajutor Microsoft HTML
Există doar un pas pentru ca documentația creată cu Doxygen să fie și mai convenabilă. Programul Doxygen creează un fișier index.html. care conține linkuri către multe alte fișiere html și imagini. Este ca un mic site web, deci greoaie face documentația incomod pentru distribuție.
Cu mult timp în urmă, Microsoft a dat seama că fișierele de ajutor pentru aplicațiile Windows sunt mai bine realizate în HTML, în acest scop au dezvoltat programul HTML Help Workshop. Acest program ia fișiere create cu Doxygen și le compilează într-un fișier de ajutor CHM. Fișierele de ajutor MetaTrader 5 / MQL5 au același format.
3.1 Descărcați Atelier de Ajutor HTML
Puteți descărca și instala htmlhelp.exe de pe site-ul Web Microsoft.
Figura 13. Încărcarea atelierului de ajutor HTML
3.2 Crearea unui fișier de ajutor HTML compilat
Rezultatele Doxygen pot fi ușor convertite în fișierul de ajutor CHM utilizând Workshop-ul de Ajutor HTML. Folosind setările noastre, Doxygen creează un fișier index.hhp. gata pentru utilizare în Workshop Help HTML, așa cum se arată în Fig. 14.
Figura 14. Localizarea fișierelor index.htm și index.hhp create de Doxygen
Următorul pas este compilarea:
Figura 15. Compilarea fișierelor în CHM folosind Workshop Help HTML
când este completă, puteți să copiați și să modificați fișierul index.chm creat în dosarul MetaTrader 5 / Help, așa cum se arată în Fig. 16 și 17.
Figura 16. Localizarea fișierului de ajutor index.chm creat
Figura 17. Copiați index.chm în directorul de ajutor MQL și redenumiți-l la codul MQL5 help.chm
Aplicație. Descrierea fișierelor de arhivare atașate Doxygen files.zip
Articole similare
Trimiteți-le prietenilor: