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

Remove unnecessary include directives in header (.h) files #82

Closed
adisidev opened this issue Dec 20, 2021 · 1 comment · Fixed by #160
Closed

Remove unnecessary include directives in header (.h) files #82

adisidev opened this issue Dec 20, 2021 · 1 comment · Fixed by #160

Comments

@adisidev
Copy link
Collaborator

We should study and implement the best practices as to what and what not to include in source files compared to header files. The conventions seems to be too include as few include directives as possible. I have noticed inconsistencies in our code; the convention followed seems to be ambiguous.

These may assist in further reading and rewriting:
https://stackoverflow.com/questions/2596449/including-includes-in-header-file-vs-source-file
https://softwareengineering.stackexchange.com/questions/167723/what-should-and-what-shouldnt-be-in-a-header-file

@adisidev
Copy link
Collaborator Author

adisidev commented Mar 4, 2022

Circling back to this; removing various headers does not seem to affect compilation. Thus, some files may be including header files by virtue of being loaded after a file that uses a particular header. However, we should not let this order matter.

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 a pull request may close this issue.

1 participant