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

Select coding conventions & auto formatting #46

Open
JSYoo5B opened this issue Nov 25, 2021 · 3 comments
Open

Select coding conventions & auto formatting #46

JSYoo5B opened this issue Nov 25, 2021 · 3 comments
Assignees

Comments

@JSYoo5B
Copy link
Member

JSYoo5B commented Nov 25, 2021

When you see the codes as raw text, it has mixed tabs and spaces.

Also, comments are written in /* */ and //.
(FYI, the /* */ is basic commenting notation in old C standard, // were back-ported from C++ standard)
I don't want to force use /* */ for all the comments, but it may be effective by setting each commenting notation into its specific meaning.
ex. use /* */ for documentation formatting comments, use // for general comments in code blocks.

Maybe there would be some other things to consider for standard coding conventions in this project.
After selecting coding conventions, auto-formatting and style check automation may be required. It will improve PR review (not arguing with minor coding styles, reducing meaningless formatting commits)
Anyone who has some opinions about coding conventions, please write your opinions here.

@onting onting self-assigned this Nov 25, 2021
@JSYoo5B JSYoo5B self-assigned this Apr 8, 2022
@JSYoo5B
Copy link
Member Author

JSYoo5B commented Apr 15, 2022

Auto formatting will be handled by clang-format.

@onting
Copy link
Collaborator

onting commented Apr 15, 2022

It seems better to unify intent char to 4 spaces.
Additionally, the /* */ style would fit within information of API in header files(even though i didn't write in this style).
And // would be good for subrootine flow comments.

@onting
Copy link
Collaborator

onting commented Apr 15, 2022

Auto formatting will be handled by clang-format.

I'll check it out.

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

No branches or pull requests

2 participants