A few things to note about this particular format: The 'developed by' line -should be the name of the person or organization who initially contributed the -file. The "-*- C++ +
A few things to note about this particular format: The "-*- C++ -*-" string on the first line is there to tell Emacs that the source file is a C++ file, not a C file (Emacs assumes .h files are C files by default). Note that this tag is not necessary in .cpp files. The name of the file is also @@ -156,9 +154,9 @@ on the first line, along with a very short description of the purpose of the file. This is important when printing out code and flipping though lots of pages.
-The next section in the file is a concise note that defines the license that -the file is released under. This makes it perfectly clear what terms the source -code can be distributed under.
+The next section in the file is a concise note that defines the license +that the file is released under. This makes it perfectly clear what terms the +source code can be distributed under and should not be modified in any way.
The main body of the description does not have to be very long in most cases. Here it's only two lines. If an algorithm is being implemented or something @@ -625,6 +623,29 @@ assert(isa<PHINode>(Succ->front()) && "Only works on PHId BBs!"
You get the idea...
+Please be aware when adding assert statements that not all compilers are aware of +the semantics of the assert. In some places, asserts are used to indicate a piece of +code that should not be reached. These are typically of the form:
+ ++assert(0 && "Some helpful error message"); ++
When used in a function that returns a value, they should be followed with a return +statement and a comment indicating that this line is never reached. This will prevent +a compiler which is unable to deduce that the assert statement never returns from +generating a warning.
+ ++assert(0 && "Some helpful error message"); +// Not reached +return 0; ++