c# - C# デストラクタに XML ドキュメントが必要なのはなぜですか?

Question

私は、C# コードのコメントと Xml ドキュメントを最小限に抑えるようにしています。代わりに、可能であればコードを自己文書化することを好みます。

しかし、パブリッククラスのデストラクタに Xml コメントを付けないと、C# コンパイラから警告が表示されます。どうしてこれなの？

ここで Xml コメントに入力する必要がある有用な情報はありますか。これは行っていません。デストラクタのコメントを自分で読む必要があるとは思いませんでした。コンパイラは熱心すぎるだけですか？

score 2 · Accepted Answer

XML Doc コメントをオンにすると、コンパイラは、API のすべてを文書化するよう要求します。デストラクタは API の一部であり、実際に含める必要があります。

デストラクタは通常、クラスにのみ存在する必要があり、文書化すると、(正しく実装されていれば) GC の負荷が大幅に軽減されるため、オブジェクトIDisposableを呼び出すように人々に通知/思い出させるのに役立ちます。Dispose()

score 1 · Accepted Answer

証拠はありませんが、プライベートとしてマークされていないすべてのメソッドのドキュメントコメントを検索するという理由だけで警告が発生するのではないかと思います。デストラクタが特にコメントを必要とする特定のルールがあるとは思えません。

score 0 · Accepted Answer

あなたのコードを使用する人なら誰でも、ファイナライザーが何をするのかを正確に知ることが役立つかもしれません。つまり、多数の管理されていないリソースを使用している場合は、リソースが解放されたときにクラスがそれらのリソースをどのように処理するかをドキュメントで明確に説明しておくと役立ちます。

score 0 · Accepted Answer

あなたのクラスは public であり、C# デストラクタは、アセンブリの外部から見える保護されたメソッドをオーバーライドすることになるため、それを主張します。

4 に答える 4