visual-studio - GhostDocを使用して、クラス全体またはコードファイルにドキュメントを追加できますか？

Question

GhostDocは大好きですが、一度に1人のメンバーだけでなく、ファイル全体に対して「これを文書化」できるようにしたいと考えています。これは可能ですか？

Answer 1

私が最初にこの質問に答えたとき、これはGhostDoc、または私の（同様の）アドインであるAtomineer ProDocumentationでは不可能でした。

（これはAtomineerでの意図的な設計の選択であり、おそらくGhostDocでも、すべてを自動的に文書化して先に進むことは一般的に悪い考えであるためです。これらのアドインは両方とも、メソッドの文書化の妥当な出発点を生成し、場合によっては優れたものを提供します。調整を行う必要がないほど十分なドキュメントですが、ほとんどの場合、結果のコメントを微調整する必要があります。ドキュメントセット全体を自動生成すると、ドキュメントはほとんど機能しないため、かなり貧弱になります。コード要素名がすでに述べていることを説明するだけではありません）。

ただし、両方のアドインでこの機能が提供されるようになりました。これは、次の状況で非常に役立ちます。

• （Atomineerの場合）JavaDoc、Doxygen、Qt、およびXMLドキュメント形式間でレガシーコメントをバッチ変換する
• （Atomineerの場合）AtomineerUtilsのフォーマットオプションを変更した後、ドキュメントコメントのスタイル/レイアウトを更新するには
• （両方のアドインで）スケルトンドキュメントをクラスにすばやく追加するには

これらすべての状況で、結果のコメントを確認することを強くお勧めしますが、更新を自動化すると多くの時間を節約できます。

Answer 2

いいえ、それでも私はまだそれが大好きです。

Answer 3

ドキュメントファイルオプションを使用する：

ファイル内のすべてのメンバーに追加されたコメントを参照してください。