diff --git a/README.md b/README.md index 94834321da..10f979d2f0 100644 --- a/README.md +++ b/README.md @@ -565,8 +565,8 @@ To enhance the generated docs with human-friendly descriptions, you can annotate [ProducesResponseType(500)] public Product GetById(int id) ``` - -4. You can also annotate types with summary and example tags: + +4. Annotate your types with summary and example tags, other tags (remarks, para, etc.) are not supported: ```csharp public class Product @@ -582,12 +582,12 @@ To enhance the generated docs with human-friendly descriptions, you can annotate /// /// 10 public int AvailableStock { get; set; } - + /// /// The sizes the product is available in /// /// ["Small", "Medium", "Large"] - public List Sizes { get; set; } + public List Sizes { get; set; } } ```