DOC: Add guideline on using a backslash as line continuation character #232
+39
−0
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
github-actions
bot
added
area:Appendices
Member
Author
|
@N-Dekker, I was unable to write to your branch, so I created this new PR with the recommended updates. |
There was a problem hiding this comment.
Pull request overview
This pull request adds a new coding style guideline about using backslashes as line continuation characters in C++ code. The guideline warns about readability issues and unintended consequences when using backslashes, particularly in comments and multi-line string literals.
Changes:
- Added a new "Backslashes" section to the coding style guide
- Provided concrete examples showing problematic backslash usage and better alternatives
- Established that backslashes are discouraged in standard C++ code but allowed in preprocessor macros
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Follow-up to ITK pull request InsightSoftwareConsortium/ITK#3713 commit InsightSoftwareConsortium/ITK@69151c3 "STYLE: Remove backslash + indent from literals, to avoid unwanted spaces"
hjmjohnson
force-pushed
the
guideline-backslash-line-continuation-char-updated
branch
from
e12796e to
b2b20b0
Compare
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.
Replace #190 with recommendations implemented.
Follow-up to ITK pull request
InsightSoftwareConsortium/ITK#3713 commit
InsightSoftwareConsortium/ITK@69151c3
"STYLE: Remove backslash + indent from literals, to avoid unwanted spaces"