您可以使用Nameof或其他技术将过程名称动态地嵌入到代码注释中吗?

时间:2019-03-05 05:10:58

标签: vb.net

如果SampelSubName的名称被更改,以下注释行将变得不正确。 “这是有关SampleSubName的代码注释。

2 个答案:

答案 0 :(得分:1)

如果使用Visual Studio 2015或更高版本,则使用内置重构工具重命名方法还将重命名XML注释中的所有引用。您可以使用<see>标记来引用方法名称,例如

/// <summary>
/// This is a code comment about <see cref="SampelSubName" />.
/// </summary>
public void SampelSubName() { }

答案 1 :(得分:1)

另一种技术。 Visual Studio IDE支持XML注释,如下所示:

/// <remarks>This is a code comment about <see cref="SampelSubName"/>. </remarks>

如果您要编写这样的注释并将SampelSubName重命名为其他名称,IDE还将更新这些cref=参考。

有关XML注释的更多信息,请参见this article