为每个班级成员写一个班级的成员类型是否有意义?

时间:2010-03-04 23:06:36

标签: comments xml-comments

在这样的代码中写评论是否有意义?

/// <Remarks>
/// Name of abc - public property.
/// </Remarks>

在visual studio中,intellisense有每种类型的成员(字段,属性等)的图标,所以我没有看到这一点。在我目前的商店中,我们只使用Visual Studio,它提供了这些图标。

由于

1 个答案:

答案 0 :(得分:1)

对我来说似乎没用。我会避免它,因为正如你所说的那样,这是可以从代码中推断出来的,而且是微不足道的。 (编辑:FWIW,也许它对你的组织运行的某些工具来说很有用,而且该工具不够智能,无法检测属性与字段,但我怀疑是这种情况。不过,将“冗余”数据编码到注释中(以满足工具(人类与否):P)的潜在原因。