Automatikus létrehozása dokumentáció szoftver mql5 - cikkek mql5
1. Bevezetés
A C ++, a világ is számos automatikus dokumentáció, az egyik a vezetők a Microsoft homokvár program Doxygen.
Úgy döntöttem, hogy teszteljék, milyen jól Doxygen dokumentálni tudja MQL5, ami lényegében egy részhalmaza C ++. Véleményem szerint támogatja az objektum-orientált programozás - egy fontos lépés a MQL5 lejárat, mert most a nyelv lehetővé teszi, hogy nagy osztály könyvtár. Ez a kísérlet sikeres volt, és remélem, hogy a dokumentációkat a program által Doxygen a MQL5-kódot, akkor nagyon hasznos lesz.
2. Doxygen programot
Doxygen program egy rendszer automatikus dokumentáció c nyílt forráskódú a GNU General Public License. Ez azt jelenti, hogy a fejlődés volt hasonló a többi nyílt forráskódú projektek, mint például a Linux és a Mozilla. Lehet szabadon letölthető és használható Doxygen forráskód mindenki számára nyitott. A program már fejlesztik a több fejlesztők.
2.1 Terhelés Doxygen
Doxygen programot site - www.doxygen.org. Itt található a letöltési oldalon, és töltse le a legújabb verziót Doxygen Windows. Amikor írom ezt a cikket változat volt doxygen-1.6.1, mint az 1. ábrán látható:
1. ábra: Letöltés Doxygen
2.2 beállítása és futtatása Doxygen
meg kell, hogy kis igazításokat beállítások Doxygen - add fájltípusok * * .mq5 .mqh és tartalmazza az utalást generálni HTML. A következő öt kép írja le részletesen a konfigurációs folyamatot.
Az első négy a képernyő (2-5 ábra) - opció beállítása fül „varázsló”:
2. ábra beállítása Doxygen - Wizard 1
3. ábra konfigurálása Doxygen - Wizard 2
4. ábra beállítása Doxygen - Wizard 3
5. ábra beállítása Doxygen - Wizard 4
Végül a lehetőségek „Expert” a leírás a bemeneti fájlok felvenni kívánt fájl típusokat és .mqh .mq5:
Ábra. 6. beállítása Doxygen - adja hozzá a fájltípusokat és mqh mq5
Ezzel minden készen áll. Tartsuk szem előtt, hogy Doxgyen menteni a konfigurációs adatokat a konfigurációs fájlban. Az elkészített konfigurációs fájlt csatolt a cikket.
7. ábra Running Doxygen
2.3 használata Doxygen
A program egy kiváló segítséget Doxygen (teremtett, természetesen, a Doxygen - itt az eredeti verzió HTML formátumban) részletezik a lenyűgöző tulajdonságok sorát, beleértve a kiváló megjelenítés bonyolult matematikai képletek. Mindazonáltal Doxygen is használható, mint egy egyszerű módja annak, hogy hozzon létre felhasználóbarát súgó fájlt.
Példaként úgy CiMACD :: Create () függvény MQL5 / include / Oscilators.mqh fájlt. Ne feledje, hogy a mutatók leírása fájlok hiányoznak a legelső szállítási MetaTrader 5. kapja meg őket, akkor lehet, hogy töltse le a legújabb verzióját a MetaTrader 5.
Miután a program Doxygen feldolgozás segít fájl megjelenik ábrán látható. 8:
8. ábra: A funkció leírása CiMACD :: Create () által létrehozott Doxygen
2.4 Az általunk használt Doxygen dokumentálása az összes kódot, hogy jön a MQL5
Az erőssége a Doxygen - a létrehozását súgófájljait nagy projektek. A kompozíció a MetaTrader 5 szállítás (MQL5 könyvtár) tartalmaz, több mint száz kép és .mq5 .mqh, amelyek közül sok egymással.
Ahhoz, hogy hozzon létre egy hivatkozást az egész kódot MQL5, mellékelt MetaTrader, tegye a következőket:
- Másolja a tartalmát a MQL5 könyvtár alkönyvtárakat a MQL5 / fájlokat.
- A fájl törlése MQL5 / files / MQL5 / include / Strings / string.mqh - ismeretlen okból Doxygen nem tudja értelmezni azt.
A kapott dokumentáció jó minőségű és gyorsan bizonyítja javára - példák ábrán mutatjuk be a 9-12.
9. ábra Osztályok jegyzéke készítette Doxygen
10. ábra osztálydiagram CArrayObj leszármazottai által létrehozott Doxygen
Ábra. 11. List osztály CArrayObj funkciókat létre Doxygen
12. ábra: a meghatározások listáját (határozza meg), a Doxygen
3. Microsoft HTML Help Workshop Program
Már csak egy lépés annak érdekében, hogy sokkal kényelmesebb a dokumentáció segítségével létrehozott Doxygen. Doxygen program létrehoz egy index.html fájlt. amely hivatkozásokat tartalmaz sok más html-fájlok és képek. Úgy néz ki, mint egy kis web-site, mint a kínos teszi kényelmetlen dokumentáció forgalmazás.
Réges-régen, a Microsoft felismerte, hogy a segítő fájlok a Windows alapú alkalmazások jobban HTML, erre a célra, az általuk kifejlesztett egy programot HTML Help Workshop. Ez a program veszi a létrehozott fájlok Doxygen, és állítja össze őket egy CHM súgó fájlt. Súgó fájlokat a MetaTrader 5 / MQL5 azonos formátumban.
3.1 betöltése a HTML Help Workshop
Itt lehet letölteni és telepíteni htmlhelp.exe a Microsoft.
13. ábra: Töltés HTML Help Workshop
3.2 Készítsen egy lefordított HTML súgó fájlt
Doxygen Az eredmények könnyen átalakítható CHM súgó fájlt HTML Help Workshop programmal. A beállítási, Doxygen teremt index.hhp fájlt. használatra kész a program HTML Help Workshop, ábrán látható. 14.
14. ábra: Tegyünk egy index.htm és index.hhp fájlok által létrehozott Doxygen
A következő lépés - a sort:
15. ábra Fordítsuk le a fájlokat CHM HTML Help Workshop
Amikor elkészült, akkor másolja és peremenovat index.chm kialakított fájlt a MetaTrader 5 / Súgó ábrán látható. 16 és 17.
16. ábra: Location segítséget létrehozott fájl index.chm
17. ábra: Copy index.chm az MMS referencia könyvtárban és nevezze a MQL5 kódkészlet help.chm