대부분의 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 코드용 자동 생성 설명서 가 게재되었습니다:
대부분의 Java 코더는 JavaDocs로 작성할 수 있는 자동 생성된 문서에 익숙합니다. 이 아이디어는 코드에 주석을 반구조적인 방식으로 추가한 후 쉽게 탐색할 수 있는 도움말 파일로 추출하는 것입니다. 또한 C++ 월드에는 Microsoft의 SandCastle과 Doxygen이 두 선두 업체인 수많은 문서 자동 생성기가 있습니다. 이 문서에서는 Doxygen을 사용하여 MQL5 코드의 구조화된 주석에서 HTML 도움말 파일을 만드는 방법에 대해 설명합니다. 실험은 매우 잘 진행되었고 Doxygen이 MQL5 코드로 제작한 도움말 문서는 많은 가치를 추가할 것이라고 생각합니다.
Doxygen의 가장 강력한 기능은 대규모 프로젝트를 위한 도움말 파일을 만드는 것입니다. MQL5 폴더 아래에 MetaTrader 5와 함께 배포되는 파일에는 100개 이상의 .mq5 및 .mqh 파일이 있으며, 이 파일 중 대부분은 상호 연관되어 있습니다.
위에 설명된 Doxygen 주석 변환에 대한 기본 메타 인용을 수행하는 유틸리티 스크립트 MetaquotesCommentsToDoxygen.mq5 (첨부된 zip 파일에 포함)를 작성했습니다. 이 단계는 도움말 파일을 만드는 데 꼭 필요한 단계는 아니지만 Doxygen의 유용한 추가 문서 기능을 보여 줍니다.
MQL5 코드셋 도움말 파일을 만드는 데 사용한 절차는 다음과 같습니다.
구조화된 주석의 추가 설명에 대한 선택 사항:
결과 도움말 문서는 품질이 우수하고 유용성이 빠르게 입증됩니다. 그림 9에서 12는 확인할 수 있는 내용의 표본입니다.
그림 9. Doxygen이 생성한 클래스 목록
작성자: Paul