-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Standardize Comments #4820
Standardize Comments #4820
Conversation
bench: 1453057
bench: 1453057
bench: 1453057
I believe the two vs. three slashes has to do with the scope or visibility of the functions that are being commented (maybe somebody can explain). I don't have particularly strong opinion of that one, it has not been particularly useful for me, but maybe others like this. |
A somewhat more useful change for modern ide's is to move the comment above the function directly above the function without an empty line between so that ide's can properly display the description when hovered over. I think that is kinda required by all ide's (a topic/pr on it's own). Regarding the triple slashes vs double slashes I find it rather weird and not clear on first sight, so I'm fine with enforcing double slashes throughout the code. |
so let's remove the blank line between comments and functions as part of this PR as well. It makes sense to have good IDE integration. @FauziAkram can you do that? |
@vondele Unfortunately, I'm afraid I can't do it for now. |
Comments improvement, mainly, I've noticed a mix of comment styles in our chess engine code: double slashes (//) and triple slashes (///). To enhance code consistency and readability, I propose we standardize on double slashes (//) for comments for better consistency and clarity.
Non-Functional change.