Skip to content

Commit 278366c

Browse files
jhlegarretadzenanz
authored andcommitted
DOC: Do not encourage using empty comment lines
Do not encourage using empty comment lines. Take advantage of the commit to reword the example comment, removing unnecessary wording.
1 parent ab20c3e commit 278366c

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2900,9 +2900,8 @@ \subsection{Empty Lines}
29002900
29012901
29022902
However, it is preferable to use a single empty line and use a comment block
2903-
using the \code{//} character to describe the part of the code at issue. The
2904-
comment block can start and end with an empty comment line (\code{//}), and
2905-
immediately be followed by the code, as in:
2903+
using the \code{//} character to describe the part of the code at issue, as
2904+
in:
29062905
29072906
\small
29082907
\begin{minted}[baselinestretch=1,fontsize=\footnotesize,linenos=false,bgcolor=ltgray]{cpp}
@@ -2920,10 +2919,7 @@ \subsection{Empty Lines}
29202919
return EXIT_FAILURE;
29212920
}
29222921
2923-
//
2924-
// The following code defines the input and output pixel types and their
2925-
// associated image types.
2926-
//
2922+
// Define the input and output pixel types and their associated image types.
29272923
constexpr unsigned int Dimension = 2;
29282924
29292925
using InputPixelType = short;

0 commit comments

Comments
 (0)