Skip to content

Commit

Permalink
Update CodeDocumentationGuidelines.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jfversluis authored Oct 20, 2022
1 parent 487845d commit b03e06d
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/CodeDocumentationGuidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ If you're unsure about how to document a certain element, have a look the [.NET
These are the tags that we would like to see when applicable: `<summary>`, `<remarks>`, `<returns>`, `<param>`, `<exception>`, `<inheritdoc>`, `<see>`, `<c>`.

* All public members should have at the very least a `<summary>`
* Add "This is a bindable property." to the end of the summary of the regular C# properties that are bindable properties.
* Keep the descriptions short and concise
* 1-2 lines typically, no screenshots or long code-blocks (those belong in the conceptual docs)
* Make sure the spelling is correct
Expand Down

0 comments on commit b03e06d

Please sign in to comment.