core icon indicating copy to clipboard operation
core copied to clipboard
verified publisher icon codidact

Documented code

Open ghost opened this issue 5 years ago • 1 comments

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

ghost avatar May 06 '20 18:05 ghost

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

misha130 avatar May 06 '20 19:05 misha130