"MQL5 Kodu için Otomatik Oluşturulan Belgeler" makalesi için tartışma

Yeni yorum
 

Yeni makale MQL5 Kodu için Otomatik Oluşturulan Belgeler yayınlandı:

Çoğu Java kodlayıcısı, JavaDocs ile oluşturulabilen otomatik olarak oluşturulmuş belgelere aşinadır. Buradaki fikir, koda daha sonra gezinmesi kolay bir yardım dosyasına çıkarılabilecek yarı yapılandırılmış bir şekilde açıklamalar eklemektir. C++ dünyası ayrıca Microsoft SandCastle ve Doxygen'in iki lider olduğu bir dizi otomatik belge oluşturucu içerir. Makalede, MQL5 kodundaki yapılandırılmış açıklamalardan HTML yardım dosyası oluşturmak için Doxygen'in kullanımı açıklanmaktadır. Deneme çok iyi çalıştı ve Doxygen'in MQL5 kodundan ürettiği yardım belgelerinin büyük bir değer katacağına inanıyorum.

Doxygen'in en güçlü olduğu konu, büyük projeler için bir yardım dosyası oluşturmaktır. MetaTrader 5 ile MQL5 klasörü altında dağıtılan, çoğu birbiriyle ilişkili yüzün üzerinde .mq5 ve .mqh dosyasıdır.

Yukarıda özetlenen temel Metaquotes - Doxygen açıklama dönüştürmelerini gerçekleştiren MetaquotesCommentsToDoxygen.mq5 (ekli zip dosyasında yer alır) bir yardımcı script dosyası yazdım. Bu, bir yardım dosyası oluşturmak için gerekli bir adım değildir, ancak Doxygen'in faydalı ek belgeleme özelliklerinin bir gösterimini sağlar.

Bir MQL5 kod kümesi yardım dosyası oluşturmak için kullandığım yordam aşağıdaki gibidir.

  • MQL5 klasörünü ve alt klasörlerini MQL5/files içine kopyalayın
  • MQL5/files/MQL5/Include/Strings/string.mqh'yi kaldırın - bilinmeyen bir nedenle bu dosya Doxygen'in kod ayrıştırmasını tamamlamasını engelledi

Yapılandırılmış açıklamalardan ek belgeler için isteğe bağlı:

  • MQL5/Files klasöründen, Windows/DOS komutunu xcopy *.mq* c:\ /S/L > MQL5codeList.txt çalıştırın
  • Herhangi bir grafikte MetaquotesCommentsToDoxygen.mq5 script dosyasını yürütün

Ortaya çıkan yardım belgeleri kalitelidir ve kullanışlılığını hızlı bir şekilde gösterir - Şekil 9 ila 12, gördüklerinize ilişkin örnekler içerir


Yazar: Paul

Yeni yorum