Discusión sobre el artículo "Documentación generada automáticamente para el código de MQL5"
¡Bien hecho! Aunque sólo es adecuado si usted vende bibliotecas MQL5 :(
Buen artículo.
¿Puedo usarlo con MQL4? Es muy parecido a C después de todo, y se supone que doxygen también lo soporta.
Sí, funciona gordon. Hay una opción en la segunda pantalla del Modo Asistente para "optimizar para salida C o PHP". Obviamente todas las funciones MQL4 son globales, por lo que no hay ventajas de la agrupación de clases MQL5.
He adjuntado una captura de pantalla a continuación de algunos de salida para LibOrderReliable utilizando la opción C. LibOrderReliable es una envoltura muy bien documentado para las funciones de comercio MQL4 para hacerlos más a prueba de fallos. Para tener la documentación aparece en la salida Doxygen, los comentarios en el código necesitaría ajustes similares a los que hice en el código MQL5.
Paul
http://p aulsfxrandomwalk.blogspot.com/
.JPG)
Ah, ya veo lo que quieres decir sobre las clases. Así que tal vez no realmente vale la pena usarlo para MQL4.
Es importante especificar la codificación correcta al crear documentación para programas que contengan comentarios en ruso.
De lo contrario puede obtener cuadrados en lugar de comentarios en ruso:
Por defecto en Doxygen en las opciones del proyecto (Experto->Proyecto) la opción DOXYFILE_ENCODING está establecida en UTF-8,
por lo que al preparar la documentación es mejor crear una carpeta separada con los archivos guardados en codificación UTF-8:
El resultado es:
Otra opción importante OUTPUT_LANGUAGE, con el idioma especificado (ruso) permite crear menús y descripciones en ruso:
La documentación facilita el estudio de la estructura y propiedades de los programas, por lo que hay que intentar adjuntar documentación a los códigos fuente.
- 2009.11.23
- Paul
- www.mql5.com
Por lo tanto, al preparar la documentación, es mejor crear una carpeta separada con los archivos guardados en codificación UTF-8:
Es más fácil establecer INPUT_ENCODING como windows-1251 en la pestaña Entrada. Y no hay problemas con las codificaciones
Por supuesto que sería más fácil.
pero por alguna razón doxygen (tengo 1.6.2) inserta en todos los ficheros
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
aunque en la configuración
es decir, los archivos están en la codificación requerida, y la pantalla se puede corregir si en todos los html-archivos reemplazar con:
<meta http-equiv="Content-Type" content="text/xhtml;charset=windows1251"/>.
- Aplicaciones de trading gratuitas
- 8 000+ señales para copiar
- Noticias económicas para analizar los mercados financieros
Usted acepta la política del sitio web y las condiciones de uso
Artículo publicado Documentación generada automáticamente para el código de MQL5:
La mayoría de desarrolladores de código Java estarán familiarizados con la documentación generada automáticamente que puede obtenerse con JavaDocs. La idea es añadir comentarios al código de forma semiestructurada para que pueda ser extraída en forma de una archivo de ayuda por el que sea fácil navegar.
El mundo de C++ tiene también una serie de autogeneradores de documentación, siendo líderes SandCastle y Doxygen, ambos de Microsoft. He decidido ver que tal puede Doxygen generar documentación en MQL5, que es en esencia un subconjunto personalizado de C++. Para mí, este es un paso importante en la madurez de MQL5, ya que la complejidad del lenguaje es capaz de mejorar fácilmente algunas librerías de clases muy grandes.
El experimento funcionó muy bien y creo que la documentación de ayuda que ofrece Doxygen a partir del código MQL5 añadirá una gran cantidad de valor a este.
Autor: Paul