기고글 토론 "MQL5 코드용 자동 생성 설명서"

새 코멘트
 

새로운 기고글 MQL5 코드용 자동 생성 설명서 가 게재되었습니다:

대부분의 Java 코더는 JavaDocs로 작성할 수 있는 자동 생성된 문서에 익숙합니다. 이 아이디어는 코드에 주석을 반구조적인 방식으로 추가한 후 쉽게 탐색할 수 있는 도움말 파일로 추출하는 것입니다. 또한 C++ 월드에는 Microsoft의 SandCastle과 Doxygen이 두 선두 업체인 수많은 문서 자동 생성기가 있습니다. 이 문서에서는 Doxygen을 사용하여 MQL5 코드의 구조화된 주석에서 HTML 도움말 파일을 만드는 방법에 대해 설명합니다. 실험은 매우 잘 진행되었고 Doxygen이 MQL5 코드로 제작한 도움말 문서는 많은 가치를 추가할 것이라고 생각합니다.

Doxygen의 가장 강력한 기능은 대규모 프로젝트를 위한 도움말 파일을 만드는 것입니다. MQL5 폴더 아래에 MetaTrader 5와 함께 배포되는 파일에는 100개 이상의 .mq5 및 .mqh 파일이 있으며, 이 파일 중 대부분은 상호 연관되어 있습니다.

위에 설명된 Doxygen 주석 변환에 대한 기본 메타 인용을 수행하는 유틸리티 스크립트 MetaquotesCommentsToDoxygen.mq5 (첨부된 zip 파일에 포함)를 작성했습니다. 이 단계는 도움말 파일을 만드는 데 꼭 필요한 단계는 아니지만 Doxygen의 유용한 추가 문서 기능을 보여 줍니다.

MQL5 코드셋 도움말 파일을 만드는 데 사용한 절차는 다음과 같습니다.

  • MQL5 폴더 및 하위 폴더를 MQL5/files로 복사합니다.
  • 제거하세요. MQL5/files/MQL5/Include/Strings/string.mqh -알 수 없는 이유로 Doxygen이 코드 구문 분석을 완료할 수 없기 때문입니다.

구조화된 주석의 추가 설명에 대한 선택 사항:

  • MQL5/Files 폴더에서, 다음을 실행합니다. Windows/DOS command xcopy *.mq* c:\ /S/L > MQL5codeList.txt
  • 모든 차트에서 MetaquotesCommentsToDoxygen.mq5 스크립트를 실행합니다.

결과 도움말 문서는 품질이 우수하고 유용성이 빠르게 입증됩니다. 그림 9에서 12는 확인할 수 있는 내용의 표본입니다.


그림 9. Doxygen이 생성한 클래스 목록

작성자: Paul

 

잘했어요! MQL5 라이브러리를 판매하는 경우에만 적합하지만 :(

 

좋은 기사입니다!

 
MQL4와 함께 사용할 수 있나요? 네. 결국 C와 매우 유사하며 산소도 이를 지원해야 합니다.
 
gordon   :
MQL4와 함께 사용할 수 있나요? 결국 C와 매우 유사하며 doxygen도 이를 지원해야 합니다.

네, 작동합니다. 두 번째 마법사 모드 화면에 "C 또는 PHP 출력에 최적화"라는 옵션이 있습니다. 물론 모든 MQL4 함수는 전역이므로 MQL5 클래스 그룹화의 이점은 없습니다.

아래에 C 옵션을 사용하는 LibOrderReliable의 일부 출력 스크린샷을 첨부했습니다. LibOrderReliable는 MQL4 거래 함수를 보다 안전하게 만들기 위해 매우 잘 문서화된 래퍼입니다. 문서가 Doxygen 출력에 표시되도록 하려면 코드 내 주석이 MQL5 코드에서 했던 것과 비슷하게 조정되어야 합니다.

Paul

http://p aulsfxrandomwalk.blogspot.com/

 

아, 클래스에 대해 무슨 말씀이신지 알겠습니다. 그래서 MQL4에 사용할 가치가 없을 수도 있습니다.

 
기사 감사합니다! 내가 필요한 것만. MSDN 스타일의 생성기가 있을까요?
 

러시아어로 된 주석이 포함된 프로그램에 대한 문서를 만들 때는 올바른 인코딩을 지정하는 것이 중요합니다.

그렇지 않으면 러시아어 주석 대신 사각형이 표시될 수 있습니다:

기본적으로 Doxygen의 프로젝트 옵션(전문가->프로젝트)에서 DOXYFILE_ENCODING 옵션은 UTF-8로 설정되어 있습니다,

따라서 문서를 준비할 때 UTF-8 인코딩으로 저장된 파일로 별도의 폴더를 만드는 것이 좋습니다:

결과는 다음과 같습니다:

지정된 언어 (러시아어)로 또 다른 중요한 옵션 OUTPUT_LANGUAGE를 사용하면 러시아어로 메뉴와 설명을 만들 수 있습니다:

문서를 사용하면 프로그램의 구조와 속성을 더 쉽게 연구할 수 있으므로 소스 코드에 문서를 첨부하세요.

Автоматическое создание документации к программам на 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_ENCODING을 windows-1251로 설정하는 것이 더 쉽습니다. 그리고 인코딩에 문제가 없습니다.
 
GarF1eld писал(а) # :
입력 탭에서 입력_인코딩을 windows-1251로 설정하는 것이 더 쉽습니다. 그리고 인코딩에 문제가 없습니다.

물론 그게 더 쉬울 것입니다.

하지만 어떤 이유에서인지 모든 파일에 산소 (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
새 코멘트