自動コードドキュメントジェネレーター

いくつかのコードドキュメントジェネレーターを紹介したいと思います。 もちろん、そのうちの1つを取り出して有効にしたいのですが、いくつかの問題がありますので、あなたはあなたの脳をそのままにして、この全体の統合でそれを苦しめないでください。



最初の主な問題は、現在のプロジェクトがWebアプリケーションであることです。 2つの言語を使用します。 クライアント側のJavaScriptとサーバー側のPHP。 ドキュメントは、サーバー側とクライアント側の両方に必要です。 概して、kosherだけが、2つの異なるドキュメントジェネレーターの使用を妨げるものではありません。 しかし、プロジェクトの両方の部分が同じように処理されるようにしたいです。 1つのプロジェクトのさまざまな部分について、ドキュメントの外観を変えたくありません。 さらに、おそらく異なる構文要件がありますが、これも悪いことです。



2番目の問題は、ジェネレーターがJavaScriptコードを解析できないことです。 私はほとんどDoxygenを選択しましたが、ストリートJavaScriptの魔法を彼に教えるまでは、それを使用することはできません。 代替案から、 JsDocToolkitのような獣が見つかりました。 しかし、彼はほとんど稼いだだけでした。 これは既に指標になっていますが、まだ設定しておらず、コード内に良いコメントはほとんどありません。



3番目の問題は、サーバー部分でOOPが実際に使用されないことです。 しかし、いずれにせよ、OOPを使用してサーバー側をリファクタリングする計画は長い間ハングしていました。 たぶんPythonでも。 したがって、時間の経過とともに、この問題は同じように消えていきます。 さらに、モジュラー構造が現在あります。 リファクタリングの問題は発生しないはずです。



まとめます。 彼らのさまざまな代表を中心に、私はDoxygenに決めました。 約束に従って、サポートされていない言語で動作するように構成できます。 さらに、それ自体は、他の開発よりも強力に見えるため、柔軟性に期待が持てます。



残念ながら、パワーと柔軟性の意味はたった1つです。Doxygenを習得するのは非常に難しいことは確かです。 そして、なぜこれがすべて必要なのか、なぜそれがより簡単な方法でできないのかを説明する必要があります。 Doxygenに関するRussifiedサイトを見つけようとしても、そのようなものは見つかりませんでした。 たぶん誰かが私に適切な何かを伝えることができますか？ または、このソリューションを実装して使用するには、英語のドキュメントを翻訳する必要がありますか？



実装の結果について報告します :)