C# Ndoc关于物业的最佳实践？

我的项目经理上周暗示在类中的属性上使用ndoc。这是应该做的吗？是否认为这样做是最佳实践？我目前正在为一个项目的一部分扩展我的所有ndoc，但不知道我需要做多深。当然，我已经为类和每个方法提供了摘要、参数、返回和注释，但是属性也需要ndoc吗？

就像其他成员一样，属性的含义应该记录在案。这不仅应包括财产的功能或用途，还应包括其初始值、特殊情况（例如，不得分配的值；可能导致异常或自动替换为其他值的值），以及在可能的情况下重写派生类中的属性的后果和目的。

与任何其他成员一样，应该记录属性的含义。这不仅应包括财产的功能或用途，还应包括其初始值、特殊情况（例如，不得分配的值；可能导致异常或自动替换为其他值的值），以及在可能的情况下重写派生类中的属性的后果和目的。

公共属性是与外部世界的契约，我认为应该记录它们

内部属性将仅在同一程序集中使用，因此您可以不记录它们

受保护的属性仅在派生类（内部或公共）中使用，因此它们可能需要一些文档

私有属性将只在类本身中使用，因此，您也可以不使用它

请注意，“不记录就可以逃脱”暗示了我的感受：你应该记录。同时我意识到有时候你需要做一件事或另一件事

---

也许你应该在

上问这个问题，公共财产是与外部世界签订的合同，我认为它们应该记录在案

内部属性将仅在同一程序集中使用，因此您可以不记录它们

受保护的属性仅在派生类（内部或公共）中使用，因此它们可能需要一些文档

私有属性将只在类本身中使用，因此，您也可以不使用它

请注意，“不记录就可以逃脱”暗示了我的感受：你应该记录。同时我意识到有时候你需要做一件事或另一件事

---

也许您应该在公共属性上询问这一点，无论您选择的文档工作流程使用GhostDoc、NDoc还是其他什么，都应该始终记录公共属性。当人们使用Intellisence时，公共属性和方法的XML注释会显示在Intellisence中，因此没有理由不在其中添加内容。即使属性的名称解释了它的功能，也很高兴有XML注释来确认这一点。很多代码中都有很多陷阱，所以让使用你的代码的人知道他们没有遇到陷阱是有礼貌的

---

私有财产可以走任何一条路。我不太愿意把它称为一种特殊的最佳实践，因为要看到课堂上的评论，你必须在课堂上，这时你可以简单地看一下它的用法。也就是说，我仍然将XML注释放在私有属性上，如果不是为其他人，那么是为我自己。6个月后，您将无法记住自己在做什么，您可以添加的任何结构化注释都将使您更容易从上次中断的地方恢复过来。

无论您选择的文档工作流程使用GhostDoc、NDoc还是其他什么，都应该始终记录公共属性。当人们使用Intellisence时，公共属性和方法的XML注释会显示在Intellisence中，因此没有理由不在其中添加内容。即使属性的名称解释了它的功能，也很高兴有XML注释来确认这一点。很多代码中都有很多陷阱，所以让使用你的代码的人知道他们没有遇到陷阱是有礼貌的

私有财产可以走任何一条路。我不太愿意把它称为一种特殊的最佳实践，因为要看到课堂上的评论，你必须在课堂上，这时你可以简单地看一下它的用法。也就是说，我仍然将XML注释放在私有属性上，如果不是为其他人，那么是为我自己。6个月后，你不可能记得自己在做什么，你可以添加的任何结构性评论都会让你更容易找到你离开的地方