diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index 0073e427721..b5946a42284 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -19,7 +19,7 @@
... and each catagory should be sorted by name.
The "Main Module Header" file applies to .cpp file -which implement an interface defined by a .h file. This #include should always -be included first regardless of where it lives on the file system. By -including a header file first in the .cpp files that implement the interfaces, -we ensure that the header does not have any hidden dependencies which are not -explicitly #included in the header, but should be. It is also a form of -documentation in the .cpp file to indicate where the interfaces it implements -are defined.
+which implement an interface defined by a .h file. This #include +should always be included first regardless of where it lives on the file +system. By including a header file first in the .cpp files that implement the +interfaces, we ensure that the header does not have any hidden dependencies +which are not explicitly #included in the header, but should be. It is also a +form of documentation in the .cpp file to indicate where the interfaces it +implements are defined.But wait, sometimes you need to have the definition of a class to use it, or -to inherit from it. In these cases go ahead and #include that header file. Be -aware however that there are many cases where you don't need to have the full -definition of a class. If you are using a pointer or reference to a class, you -don't need the header file. If you are simply returning a class instance from a -prototyped function or method, you don't need it. In fact, for most cases, you -simply don't need the definition of a class... and not #include'ing -speeds up compilation.
+to inherit from it. In these cases go ahead and #include that header +file. Be aware however that there are many cases where you don't need to have +the full definition of a class. If you are using a pointer or reference to a +class, you don't need the header file. If you are simply returning a class +instance from a prototyped function or method, you don't need it. In fact, for +most cases, you simply don't need the definition of a class... and not +#include'ing speeds up compilation.It is easy to try to go too overboard on this recommendation, however. You must include all of the header files that you are using, either directly @@ -557,7 +558,7 @@ get in the habit of always using preincrement, and you won't have a problem.