Add section about header files #6
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richiware
reviewed
Mar 19, 2021
|
|
||
| ### Including headers | ||
|
|
||
| Using angle brackets `#include <header>` is prefered over double quotes `#include "header"`, as it allows to mock a header |
Member
There was a problem hiding this comment.
It should be preferred the faster option for the preprocessor. If the path is relative, we should use #include "common/Types.hpp". If the path is not relative, we should use #include <fastdds/dds/core/Types.hpp>.
I can understand that a relative path with .. is not liked to be used because visual prettiness, like #include "../rtps/Common.hpp". Although my hand will not shake writing that. All for help to the speed of compilation.
And in case a #include "header" interferes with a mock, always we can change it to #include <header>.
Signed-off-by: Miguel Company <MiguelCompany@eprosima.com> Co-authored-by: José Luis Bueno López <69244257+JLBuenoLopez-eProsima@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.