Discussão do artigo "Documentação gerada automaticamente para o código MQL5"
Muito bem! Embora ele só seja adequado se você vender bibliotecas MQL5 :(
Ótimo artigo!
Posso usá-lo com MQL4? Afinal, ele é muito parecido com o C, e o doxygen também deve oferecer suporte a ele.
Sim, funciona, Gordon. Há uma opção na segunda tela do Wizard Mode para "otimizar para saída em C ou PHP". Obviamente, todas as funções MQL4 são globais, portanto, não há vantagens no agrupamento de classes MQL5.
Anexei uma captura de tela abaixo de alguns resultados para LibOrderReliable usando a opção C. LibOrderReliable é um invólucro muito bem documentado para as funções comerciais MQL4 para torná-las mais seguras contra falhas. Para que a documentação apareça nos resultados do Doxygen, os comentários no código precisariam de ajustes semelhantes aos que fiz no código MQL5.
Paulo
http://p aulsfxrandomwalk.blogspot.com/
.JPG)
Ah, entendi o que você quis dizer sobre as classes. Portanto, talvez não valha a pena usá-lo para MQL4.
É importante especificar a codificação correta ao criar documentação para programas que contêm comentários em russo.
Caso contrário, você poderá obter quadrados em vez de comentários em russo:
Por padrão, no Doxygen, nas opções do projeto (Expert->Project), a opção DOXYFILE_ENCODING é definida como UTF-8,
portanto, ao preparar a documentação, é melhor criar uma pasta separada com arquivos salvos na codificação UTF-8:
O resultado é:
Outra opção importante, OUTPUT_LANGUAGE, com o idioma especificado (russo), permite que você crie menus e descrições em russo:
A documentação facilita o estudo da estrutura e das propriedades dos programas, portanto, tente anexar a documentação aos códigos-fonte.
- 2009.11.23
- Paul
- www.mql5.com
Portanto, ao preparar a documentação, é melhor criar uma pasta separada com arquivos salvos na codificação UTF-8:
É mais fácil definir INPUT_ENCODING como windows-1251 na guia Input. E não há problemas com codificações
É claro que isso seria mais fácil.
Mas, por algum motivo, o doxygen (tenho a versão 1.6.2) insere em todos os arquivos
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
embora nas configurações
ou seja, os arquivos estão na codificação necessária, e a exibição pode ser corrigida se todos os arquivos html forem substituídos por:
<meta http-equiv="Content-Type" content="text/xhtml;charset=windows1251"/>
- Aplicativos de negociação gratuitos
- 8 000+ sinais para cópia
- Notícias econômicas para análise dos mercados financeiros
Você concorda com a política do site e com os termos de uso
Novo artigo Documentação gerada automaticamente para o código MQL5 foi publicado:
A maioria dos codificadores Java estará familiarizada com a documentação gerada automaticamente com o JavaDocs. A ideia é adicionar comentários no código de uma maneira semi-estruturada que possam ser extraídos em um arquivo de ajuda fácil de navegar. O mundo do C++ também possui vários geradores automáticos de documentação, com os dois líderes sendo o SandCastle da Microsoft e o Doxygen. O artigo descreve o uso do Doxygen para criar o arquivo de ajuda HTML a partir dos comentários estruturados no código MQL5. O experimento funcionou muito bem, acredito que a documentação de ajuda que o Doxygen produz do código MQL5 irá agregar uma grande quantidade de valor.
Autor: Paul