DOC: Add guideline on using a backslash as line continuation character #232
Conversation
Follow-up to ITK pull request InsightSoftwareConsortium/ITK#3713 commit InsightSoftwareConsortium/ITK@69151c3 "STYLE: Remove backslash + indent from literals, to avoid unwanted spaces"
github-actions
bot
added
area:Appendices
|
@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.
| \small | ||
| \begin{minted}[baselinestretch=1,fontsize=\footnotesize,linenos=false,bgcolor=ltgray]{cpp} | ||
| // Wil we go to sleep or not? \ |
There was a problem hiding this comment.
Typo in the code comment: "Wil" should be "Will".
| // Wil we go to sleep or not? \ | |
| // Will we go to sleep or not? \ |
| Backslashes are allowed when defining a lengthy preprocessor macro definitions to allow for | ||
| improved readability when it spans multiple lines. |
There was a problem hiding this comment.
Grammar issue: "macro definitions" is redundant when preceded by "preprocessor macro". Either use "preprocessor macro definitions" or "macros" (removing "definitions"), or simply "lengthy preprocessor macros".
| Backslashes are allowed when defining a lengthy preprocessor macro definitions to allow for | |
| improved readability when it spans multiple lines. | |
| Backslashes are allowed when defining lengthy preprocessor macros to allow for | |
| improved readability when they span multiple lines. |
| \end{minted} | ||
| \normalsize | ||
| The use of a backslash as line continuation character is discouraged in standard c++ code blocks. |
There was a problem hiding this comment.
Inconsistent capitalization: "c++" should be "C++" to match the capitalization used elsewhere in the document (see line 3267 where "C++" is correctly capitalized).
| The use of a backslash as line continuation character is discouraged in standard c++ code blocks. | |
| The use of a backslash as line continuation character is discouraged in standard C++ code blocks. |
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"