-
Notifications
You must be signed in to change notification settings - Fork 255
Closed
Labels
good first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
We should add XML comments for all publicly visible types or members. This will improve the usage, intellisense will provide information to the end users. If you want to contribute, you are welcome to do so.
Instructions:
- On each public class, public property, public method, we should add XML comment.
- Just on top o the name of class/property/method start typing three slashes
///. The VS automatically will create the skeleton for the XML comment. It looks as following:
/// <summary>
///
/// </summary>
/// <param name="id"></param>
- Try to analyze what that class or method does, and accordingly write in the comment.
In the end, anyhow we will try to review it, so don't get stuck too much :)
ardalis
Metadata
Metadata
Assignees
Labels
good first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed