Skip to content

Commit 9eeab2d

Browse files
committed
DOC: Add commentary about the coding style used.
1 parent 8fbe524 commit 9eeab2d

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,14 @@ \chapter{Coding Style Guide}
99
architectural and implementation decisions made early in the project. For
1010
example, the decision was made to implement ITK with a C++ core using
1111
principles of generic programming, so the rules are oriented towards this style
12-
of implementation. Some guidelines are relatively arbitrary, such as
13-
indentation levels and style. However, an attempt was made to find coding
14-
styles consistent with accepted practices. The point is to adhere to a common
12+
of implementation. All guidelines are strictly enforced, including whitespace
13+
indentation levels and style. Careful consideration and considerable discussion
14+
occurred in an attempt to find coding
15+
styles consistent with accepted practices in the active community.
16+
The primary goal is to adhere to a common
1517
style to assist community members of the future to learn, use, maintain, and
16-
extend ITK. A common style greatly improves readability.
18+
extend ITK. Given the fact that code is read many more times than it is written, a strong
19+
emphasis is placed on generating a common style that improves readability.
1720

1821
Please do your best to be an outstanding member of the ITK community. The rules
1922
described here have been developed with the community as a whole in mind.

0 commit comments

Comments
 (0)