Stuck on the my Joyful Documentation [closed]

Closed. This question needs details or clarity. It is not currently accepting answers.

---

Want to improve this question? Add details and clarify the problem by editing this post.

Closed 9 years ago.

Improve this question

Im writing documentation for .net services. One of my methods similar to many, returns List<RoomOccupancy>

RoomOccupancy is a custom object with fields RoomNo, StartDateTime, EndDateTime, RentalNo

My question is what is the best way to display this, and detail the parameters. How would I represent a list? Remember this is .net. So maybe readable by any language user.

Some ideas开发者_Go百科 I have thought of:

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

---

I would use something like this

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

That will create a link to the RoomOccupancy class and it's documentation.