Skip to content
This repository has been archived by the owner on Jul 17, 2020. It is now read-only.

Documented code #93

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Documented code #93

wants to merge 2 commits into from

Conversation

ghost
Copy link

@ghost ghost commented May 6, 2020

Pull Request summary

Documented the code for readability

Link to Project Card/Issue

None.

Pull Request Tasklist

  • Pull request references an issue
  • Branch follows contributing guidelines format
  • [X ] Pull request targets the develop branch

@misha130
Copy link
Contributor

misha130 commented May 6, 2020

Though this is actually super helpful some points:

  • Use xmldoc to comment methods/classes/props (write /// and the IDE completes the rest I think)
  • Some of the comments in startup.cs are not accurate as in it doesn't really configure services or cookies
  • If you are commenting code inside of a method it means this code should be moved to a separate method (as in it smells) the calls should be self explanatory with their names.

There are many many many files that I missed the documentation on props/methods/classes though and it would be great if it was addressed with xmldoc

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant