代码之家 › 专栏 › 技术社区 › GurdeepS

为每个类成员编写类的成员类型有意义吗?

xml-comments comments

0

GurdeepS · 技术社区 · 14 年前

用这样的代码写评论有意义吗?

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

在visual studio中,intellisense对于每种类型的类成员(字段、属性等)都有图标,所以我看不出这一点。在我现在的店里,我们只使用visual studio,它提供了这些图标。

谢谢

1 回复 | 直到 14 年前

1

Noon Silk 14 年前

对我来说似乎没什么用。我会避免它,因为正如您所说,它是可以从代码中推断出来的,很简单。(编辑:FWIW, 也许吧 对于您的组织运行的一些工具来说,这是很有用的,因为该工具不够聪明,无法检测属性和字段,但我怀疑情况是否如此。然而,这是将“冗余”数据编码到注释中的一个潜在原因(以满足工具(人与否:p))。