Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add pagination for repository and response message #32

Merged
merged 6 commits into from
Apr 26, 2023

Conversation

RikoLearn
Copy link
Contributor

@RikoLearn RikoLearn commented Apr 24, 2023

ITNOA

related to #11

Please review this branch:
It contains pagination on repository and responses

Copy link
Member

@soroshsabz soroshsabz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ITNOA

As you can see in https://www.codeguru.com/csharp/commenting-best-practices-in-c/#:~:text=Best%20Practices%20for%20C%23%20Commenting%20Below%20are%20some,precisely%20describe%20what%20a%20portion%20of%20code%20does.

  • Only use comments for code snippets that are hard to understand or need clarification.
  • Keep comments simple: remember their purpose. They should precisely describe what a portion of code does.
  • Don’t be rude or mean in your comments. Be professional.
  • If you change a portion of code, be certain to change the comments to!
  • If you have multiline comments or multiple inline comments, make sure they are aligned for easier readability.
  • Keep comment lines short. Use multiple lines if necessary versus cramming them all on one line.
  • Use the same style of comments as the rest of your development team or that you use in your entire application.
  • Avoid W.E.T. comments or comments that waste everyone’s time. Don’t explain something that is obvious.
  • Avoid smelly comments. Smelly comments are comments that attempt to justify or explain bad code. Rewrite your code instead. One final note about C# comments – they are not only used to tell yourself – or other developers – what your code was intended to do.

And please see https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/ and https://swimm.io/learn/code-collaboration/comments-in-code-best-practices-and-mistakes-to-avoid/ . I think these links is very useful

@soroshsabz soroshsabz merged commit d30a845 into BSVN:master Apr 26, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants