Ndoc属性最佳实践？

Question

我的项目经理上周暗示在课堂上使用ndoc属性。这是应该做的事吗？这样做或不是最佳做法吗？我正在扩展我正在研究的项目部分的所有ndoc，但不知道我需要多深入它。我当然为类和每个方法提供了摘要，参数，返回和备注，但属性是否也需要ndoc？

Answer 1

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

Answer 2

公共财产是与外界的契约我认为应该记录在案。

内部属性只能在同一个程序集中使用，因此您可以避免记录它们。

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

私有属性只会在类本身中使用，因此，您可以再次使用它。

请注意，“没有记录它”可以表明我对此的看法：你应该记录。与此同时，我意识到有时候你需要做一件事......

也许你应该在http://programmers.stackexchange.com

上问这个问题

Answer 3

无论您选择的文档工作流程使用GhostDoc，NDoc还是其他任何内容，都必须始终记录公共属性。当人们使用它时，公共属性和方法的XML注释会出现在Intellisence中，因此没有理由不在那里添加内容。即使属性的名称解释了它的作用，在那里使用XML注释来确认它也是非常好的。大量代码中存在大量问题，因此让使用代码的人知道他们不会融入其中是很有礼貌的。

私人财产可以采用任何一种方式。我会毫不犹豫地将其称为一种特殊的最佳做法，因为要查看您必须在课堂上发表的评论，此时您可以轻松地查看其用法。也就是说，我仍然将XML评论放在私有属性上，如果没有其他人那么我自己。 6个月后你无法记住你在做什么，你可以添加任何结构性评论，这样可以更容易地从你离开的地方继续。