我喜欢尽量减少 C# 代码的注释和 Xml 文档。而是希望尽可能使代码 self 记录。
但是如果我没有对公共(public)类的析构函数添加 Xml 注释,C# 编译器会发出警告。这是为什么?
是否有一些有用的信息我应该放入此处的 Xml 注释中,但我一直没有这样做。我从来没有发现需要自己阅读有关析构函数的评论。编译器是否过于热心?
最佳答案
如果您打开 XML Doc 注释,编译器将希望您记录 API 中的所有内容。析构函数是 API 的一部分,确实应该包含在内。
析构函数通常应该只存在于 IDisposable
类中,并且将其记录下来确实有助于发出信号/提醒人们在对象上调用 Dispose()
,因为这样做(如果正确实现)将显着降低 GC 压力。
关于c# - 为什么 C# 析构函数需要有 XML 文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5502728/