記事"MQL5 コード用自動作成ドキュメンテーション"についてのディスカッション

[MetaQuotes]

新しい記事 MQL5 コード用自動作成ドキュメンテーション はパブリッシュされました:

Java プログラマーの多くは JavaDocs により作成することのできる自動作成ドキュメンテーションを熟知されていることと思います。その考え方は、検索が簡単なヘルプファイルに抽出できる半構造法によりコードにコメントを追加するというものです。C++ 言語界にもまたドキュメンテーション自動作成機能があります。 Microsoft の SandCastle と Doxygen が代表的な2つです。本稿は MQL5 コードで構成済みコメントから HTML ヘルプファイルを作成するための Doxygen 使用について述べます。実験はひじょうにうまくいきましたから、Doxygen が MQL5 コードから作り出すヘルプのドキュメンテーションは大きな価値を加えると信じています。

作者: Paul

[Christo Tsvetanov]

よくやった！ただし、MQL5ライブラリを販売する場合にのみ適しています :(

[Philipp]

素晴らしい記事だ！

[gordon]

MQL4で使えますか？結局のところCに非常に似ているし、doxygenもそれをサポートすることになっている。

[Paul]

gordon   :
MQL4で使えますか？MQL4はC言語とよく似ていますし、doxygenもそれをサポートしているはずです。

はい、使えます。 ウィザード・モードの2番目の画面に、「CまたはPHP出力用に最適化する」というオプションがあります。 MQL4の関数はすべてグローバルなので、MQL5のクラス・グループ化の利点はありません。

Cオプションを使用したLibOrderReliableの 出力のスクリーンショットを以下に添付します。 LibOrderReliableは、MQL4のトレード関数をよりフェイルセーフにするための非常によく文書化されたラッパーです。 Doxygenの出力に文書を表示させるには、コード内のコメントを私がMQL5のコードで行ったものと同様に調整する必要があります。

ポール

http://p aulsfxrandomwalk.blogspot.com/

[gordon]

ああ、クラスのことですね。だから、MQL4に使う価値はあまりないかもしれないね。

[Alexander]

記事をありがとう！まさに私が必要としていたものです。もしかしたら、msdnスタイルのジェネレーターがあるかもしれませんね？

[Automated-Trading]

ロシア語のコメントを含む番組のドキュメントを作成する 場合、正しいエンコーディングを指定することが重要です。

そうしないと、ロシア語のコメントの代わりに正方形が表示されることがあります：

Doxygenのデフォルトでは、プロジェクトのオプション（Expert->Project）のDOXYFILE_ENCODING オプションはUTF-8に設定されています、

そのため、ドキュメントを作成する場合は、UTF-8エンコーディングで保存されたファイルを別のフォルダに作成したほうがよいでしょう：

となります：

もう一つの重要なオプションOUTPUT_LANGUAGEは、指定された言語（ロシア語）で、ロシア語でメニューや説明を作成することができます：

ドキュメントは、プログラムの構造やプロパティの研究を容易にするので、ソースコードにドキュメントを添付するようにしてください。

[Alexander]

Automated-Trading писал(а) # :

したがって、ドキュメントを作成する場合は、UTF-8エンコーディングで保存されたファイルを別のフォルダに作成する方がよいでしょう：

入力タブでINPUT_ENCODINGをwindows-1251に設定する方が簡単です。エンコーディングも問題ありません

[Automated-Trading]

GarF1eld писал(а) # :
入力タブで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"/> と置き換えてください。

しかし、問題は、どのようにそれを打ち破るかである。

[Alexander]

正直なところ、私はUTF-8で十分満足しているので気づかなかったし、クロコブラストで問題があったときは、INPUT_ENCODINGを変更しただけだった。