编程语言
首页 > 编程语言> > 为什么C#析构函数需要XML文档?

为什么C#析构函数需要XML文档?

作者:互联网

我喜欢将我的C#代码的注释和Xml文档保持在最低限度.更喜欢在可能的情况下使代码自我记录.

但是如果我没有在公共类的析构函数上放置Xml注释,C#编译器会发出警告.为什么是这样?

是否有一些有用的信息我应该在这里放入Xml评论中,我没有做过.我自己从未发现需要阅读析构函数的评论.编译器是否过于热心?

解决方法:

如果打开XML Doc注释,编译器将要求您记录API中的所有内容.析构函数是API的一部分,确实应该包含在内.

析构函数通常只应存在于IDisposable类上,并且记录它确实有助于发出信号/提醒人们在对象上调用Dispose(),因为这样做(如果正确实现)将显着降低GC压力.

标签:c,finalizer
来源: https://codeday.me/bug/20190630/1339619.html