停留在我的快乐文档

本文关键字:文档 我的快乐 停留在 | 更新日期: 2023-09-27 18:10:36

我在写。net服务的文档。我的一个方法类似于许多,返回List<RoomOccupancy>

RoomOccupancy是一个自定义对象,字段为RoomNo, StartDateTime, EndDateTime, RentalNo

我的问题是什么是最好的方式来显示这个,并详细说明参数。我怎么表示一个列表呢?记住这是。net。所以也许任何语言用户都能读懂。

我想到的一些主意:

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

停留在我的快乐文档

我会用这样的文字

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

这将创建一个到RoomOccupancy类和它的文档的链接。