Skip to content

Improve XML comments for public methods #3

Open
Open
Improve XML comments for public methods#3
Labels
good first issueGood for newcomershelp wantedExtra attention is needed

Description

@Timmoth
Timmoth
opened on Jun 7, 2024

It'll be helpful to communicate usage / intent to end users

See here for more details:
https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags

Including:

  • parameters
  • description
  • exceptions

Activity

  1. Timmoth
    added
    help wantedExtra attention is needed
    good first issueGood for newcomers
    on Jun 7, 2024
  2. Timmoth
    changed the title [-]Add XML comments for public interface[/-] [+]Add XML comments for public methods[/+] on Jun 7, 2024
  3. Timmoth
    changed the title [-]Add XML comments for public methods[/-] [+]Improve XML comments for public methods[/+] on Jun 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions