gpt4 book ai didi

c# - 您应该为接口(interface)、具体实现或两者编写 XML 注释吗?

转载 作者:可可西里 更新时间:2023-11-01 08:09:50 25 4
gpt4 key购买 nike

<分区>

我对应该在哪里应用我的 XML 注释感兴趣。我是否应该在接口(interface)中放置一个更通用的 XML 注释,而在实现类中放置一个更具描述性的注释?像这样:

public interface IObjectRepository
{
/// <summary>
/// Returns an object from the respository that contains the specified ID.
/// </summary>
Object GetObject(int Id);
}

public ObjectRepository : IObjectRepository
{
/// <summary>
/// Retrieves an object from the database that contains the specified ID.
/// </summary>
public Object GetObject(int Id)
{
Object myData = // Get from DB code.
return myData;
}
}

我没有包括 <param>为简单起见。

这是评论的好习惯还是有不同的方式?我只是跳过评论界面吗?

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