Discussione sull’articolo "Documentazione generata automaticamente per il codice MQL5"
Ben fatto! Anche se è adatto solo se si vendono librerie MQL5 :(
Ottimo articolo!
Posso usarlo con MQL4? È molto simile al C, dopotutto, e doxygen dovrebbe supportare anche questo.
C'è un'opzione nella seconda schermata della modalità guidata per "ottimizzare per l'output in C o PHP". Ovviamente tutte le funzioni MQL4 sono globali, quindi non ci sono vantaggi nel raggruppamento delle classi MQL5.
Ho allegato uno screenshot qui sotto di alcuni output per LibOrderReliable usando l'opzione C. LibOrderReliable è un wrapper molto ben documentato per le funzioni commerciali MQL4 per renderle più sicure. Per far apparire la documentazione nell'output Doxygen, i commenti nel codice avrebbero bisogno di modifiche simili a quelle che ho fatto sul codice MQL5.
Paolo
http://p aulsfxrandomwalk.blogspot.com/
.JPG)
Oh, capisco cosa intendi per le classi. Quindi forse non vale la pena usarlo per MQL4.
È importante specificare la codifica corretta quando si crea la documentazione per i programmi che contengono commenti in russo.
In caso contrario, si potrebbero ottenere dei quadrati al posto dei commenti in lingua russa:
Per impostazione predefinita in Doxygen, nelle opzioni del progetto (Expert->Progetto) l'opzione DOXYFILE_ENCODING è impostata su UTF-8,
quindi quando si prepara la documentazione è meglio creare una cartella separata con i file salvati in codifica UTF-8:
Il risultato è:
Un'altra importante opzione OUTPUT_LANGUAGE, con la lingua specificata (russo), consente di creare menu e descrizioni in russo:
La documentazione facilita lo studio della struttura e delle proprietà dei programmi, quindi cercate di allegare la documentazione ai codici sorgente.
- 2009.11.23
- Paul
- www.mql5.com
Per questo motivo, quando si prepara la documentazione, è meglio creare una cartella separata con i file salvati in codifica UTF-8:
È più semplice impostare INPUT_ENCODING come windows-1251 nella scheda Input. E non ci sono problemi con le codifiche
Ovviamente sarebbe più facile.
ma per qualche ragione doxygen (ho la 1.6.2) inserisce in tutti i file
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
anche se nelle impostazioni
cioè i file sono nella codifica richiesta, e la visualizzazione può essere corretta se in tutti i file html si sostituisce con:
<meta http-equiv="Content-Type" content="text/xhtml;charset=windows1251"/>.
- App di trading gratuite
- Oltre 8.000 segnali per il copy trading
- Notizie economiche per esplorare i mercati finanziari
Accetti la politica del sito e le condizioni d’uso
Il nuovo articolo Documentazione generata automaticamente per il codice MQL5 è stato pubblicato:
La maggior parte dei programmatori Java avrà familiarità con la documentazione generata automaticamente che può essere creata con JavaDocs. L'idea è di aggiungere commenti al codice in modo semi-strutturato e che possano poi essere estratti in un file di supporto di facile navigazione. Il mondo C++ ha anche una serie di generatori automatici di documentazione, con SandCastle e Doxygen di Microsoft, i due leader. L'articolo descrive l'uso di Doxygen per creare file di supporto HTML da commenti strutturati nel codice MQL5. L'esperimento ha funzionato molto bene e credo che la documentazione di supporto che Doxygen produce dal codice MQL5 aggiungerà molto valore.
C'è poco da fare, tranne aggiungere i tipi di file *.mqh e *.mq5 e attivare la generazione del supporto HTML. Le seguenti cinque cifre attraversano la configurazione.
Le prime quattro schermate (figure da 2 a 5) scorrono attraverso le schermate della procedura guidata:
Figura 2. Configurazione di Doxygen - Procedura guidata 1
Autore: Paul