gpt4 book ai didi

c# - 我应该如何编写 XML 注释以避免在摘要和返回标记之间重复自己?

转载 作者:可可西里 更新时间:2023-11-01 03:09:52 24 4
gpt4 key购买 nike

<分区>

当方法的目的是计算一个值并返回它时,我发现自己将其记录如下:

/// <summary>
/// Calculates the widget count.
/// </summary>
/// <param name="control">The control to calculate the widget count of.</param>
/// <returns>The widget count.</returns>

这里的 returns 标签没有提供任何新信息:它只是重复 summary 中的内容。 (异常(exception)是返回 bool 的方法,其中很容易解释 truefalse 返回值的含义。)

我错过了什么吗?是否有一种标准的 XML 文档 block 措辞方式来避免 summaryreturns 标记之间的重复?

24 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com