坚持我的快乐文档

Question

我正在为.net服务编写文档。 我的一种方法与许多类似，返回List<RoomOccupancy>

RoomOccupancy是一个包含字段RoomNo, StartDateTime, EndDateTime, RentalNo

的自定义对象

我的问题是显示此内容的最佳方式是什么，并详细说明参数。 我如何表示一份清单？ 记住这是.net。因此，任何语言用户都可以阅读。

我想到的一些想法：

List<RoomOccupancy>  = List<RoomNo, StartDateTime, EndDateTime, RentalNo>
List<RoomOccupancy>  = [RoomNo, StartDateTime, EndDateTime, RentalNo]     (use [] or {}? )

Answer 1

我会用这样的东西

/// <summary>
/// ...
/// </summary>
/// <returns>List of <see cref="RoomOccupancy"/></returns>

这将创建一个指向RoomOccupancy类及其文档的链接。