Обсуждение статьи "Автоматическое создание документации к программам на MQL5"

Новый комментарий
 

Опубликована статья Автоматическое создание документации к программам на MQL5:

В статье описано, как можно использовать программу Doxygen для создания структурированных файлов справки HTML для программ, написанных на MQL5. Затем они легко могут быть скомпилированы в файлы справки CHM при помощи программы Microsoft's HTML Help Workshop.

Автор: Paul

 

Молодец! Хотя годится только если продаете MQL5 библиотеки :(

 

Отличная статья!

 
Могу ли я использовать его с MQL4? В конце концов, он очень похож на C, а doxygen должен поддерживать и его.
 
gordon   :
Могу ли я использовать его с MQL4? В конце концов, он очень похож на C, а doxygen должен поддерживать и его.

Да, это работает, Гордон. На втором экране Wizard Mode есть опция "оптимизировать для вывода на C или PHP". Очевидно, что все функции MQL4 глобальны, поэтому преимущества группировки классов MQL5 отсутствуют.

Ниже я приложил скриншот вывода LibOrderReliable с использованием опции C. LibOrderReliable - это очень хорошо документированная обертка для торговых функций MQL4, чтобы сделать их более отказоустойчивыми. Чтобы документация появилась в выводе Doxygen, комментарии в коде должны быть аналогичны тем, которые я сделал для кода MQL5.

Пол

http://p aulsfxrandomwalk.blogspot.com/

 

О, я понял, что вы имеете в виду, говоря о классах. Так что, возможно, не стоит использовать его для MQL4.

 
Спасибо за статью! То что нужно. А может есть генераторы с msdn стилем?
 

Важно правильно указывать кодировку при создании документации к программам, содержащим комментарии на русском языке.

В противном случае вместо русскоязычных комментариев могут получиться квадратики:

По умолчанию в Doxygen в опциях проекта (Expert->Project) опция DOXYFILE_ENCODING установлена как UTF-8,

поэтому при подготовке документации лучше создать отдельную папку с файлами, сохраненными в кодировке UTF-8:

В результате получим:

Другая важная опция OUTPUT_LANGUAGE, с указанным языком (Russian) позволяет создавать меню и описание на русском языке:

Документация упрощает изучение структуры и свойств программ, поэтому старайтесь прикладывать документацию к исходным кодам.

Автоматическое создание документации к программам на MQL5
Автоматическое создание документации к программам на MQL5
  • 2009.11.23
  • Paul
  • www.mql5.com
Большинство Java программистов знакомы с автоматическим созданием документации, которая может быть создана при помощи программы JavaDocs. В мире C++ также есть несколько автоматических генераторов документации, одними из лидеров являются программы Microsoft's SandCastle и Doxygen. В статье описано, как можно использовать программу Doxygen для создания структурированных файлов справки HTML для программ, написанных на MQL5. Результаты данной работы убедили меня использовать Doxygen (или похожие программы) в будущем для создания документации к любому моему коду на MQL5, это значительно облегчает его понимание и использование.
 
Automated-Trading писал(а) # :

поэтому при подготовке документации лучше создать отдельную папку с файлами, сохраненными в кодировке UTF-8:

Проще на вкладке Input задать INPUT_ENCODING как windows-1251. И никаких проблем с кодировками
 
GarF1eld писал(а) # :
Проще на вкладке Input задать INPUT_ENCODING как windows-1251. И никаких проблем с кодировками

конечно так было бы проще.

но почему-то doxygen (у меня 1.6.2) во все файлы вставляет

<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

хотя в настройках

т.е файлы в нужной кодировке, а отображение можно исправить если во всех html-файлах заменить на:

<meta http-equiv="Content-Type" content="text/xhtml;charset=windows1251"/>

но вопрос в том, как побороть его, чтобы он это делал самостоятельно.
 
Честно говоря не замечал, т.к меня вполне устраивает UTF-8, а когда была проблема с крокозяблами, просто изменил INPUT_ENCODING
12
Новый комментарий