docs/CodingStandards.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <link rel="stylesheet" href="llvm.css" type="text/css">
   6   <title>A Few Coding Standards</title>
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   A Few Coding Standards
  12 </div>
  13
  14 <ol>
  15   <li><a href="#introduction">Introduction</a></li>
  16   <li><a href="#mechanicalissues">Mechanical Source Issues</a>
  17     <ol>
  18       <li><a href="#sourceformating">Source Code Formatting</a>
  19         <ol>
  20           <li><a href="#scf_commenting">Commenting</a></li>
  21           <li><a href="#scf_commentformat">Comment Formatting</a></li>
  22           <li><a href="#scf_includes">#include Style</a></li>
  23           <li><a href="#scf_codewidth">Source Code Width</a></li>
  24           <li><a href="#scf_spacestabs">Use Spaces Instead of Tabs</a></li>
  25           <li><a href="#scf_indentation">Indent Code Consistently</a></li>
  26         </ol></li>
  27       <li><a href="#compilerissues">Compiler Issues</a>
  28         <ol>
  29           <li><a href="#ci_warningerrors">Treat Compiler Warnings Like
  30               Errors</a></li>
  31           <li><a href="#ci_portable_code">Write Portable Code</a></li>
  32           <li><a href="#ci_class_struct">Use of class/struct Keywords</a></li>
  33         </ol></li>
  34     </ol></li>
  35   <li><a href="#styleissues">Style Issues</a>
  36     <ol>
  37       <li><a href="#macro">The High Level Issues</a>
  38         <ol>
  39           <li><a href="#hl_module">A Public Header File <b>is</b> a
  40               Module</a></li>
  41           <li><a href="#hl_dontinclude">#include as Little as Possible</a></li>
  42           <li><a href="#hl_privateheaders">Keep "internal" Headers
  43               Private</a></li>
  44         </ol></li>
  45       <li><a href="#micro">The Low Level Issues</a>
  46         <ol>
  47           <li><a href="#hl_assert">Assert Liberally</a></li>
  48           <li><a href="#hl_preincrement">Prefer Preincrement</a></li>
  49           <li><a href="#hl_avoidendl">Avoid std::endl</a></li>
  50           <li><a href="#hl_exploitcpp">Exploit C++ to its Fullest</a></li>
  51         </ol></li>
  52     </ol></li>
  53   <li><a href="#seealso">See Also</a></li>
  54 </ol>
  55
  56 <div class="doc_author">
  57   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
  58 </div>
  59
  60
  61 <!-- *********************************************************************** -->
  62 <div class="doc_section">
  63   <a name="introduction">Introduction</a>
  64 </div>
  65 <!-- *********************************************************************** -->
  66
  67 <div class="doc_text">
  68
  69 <p>This document attempts to describe a few coding standards that are being used
  70 in the LLVM source tree.  Although no coding standards should be regarded as
  71 absolute requirements to be followed in all instances, coding standards can be
  72 useful.</p>
  73
  74 <p>This document intentionally does not prescribe fixed standards for religious
  75 issues such as brace placement and space usage.  For issues like this, follow
  76 the golden rule:</p>
  77
  78 <blockquote>
  79
  80 <p><b><a name="goldenrule">If you are adding a significant body of source to a
  81 project, feel free to use whatever style you are most comfortable with.  If you
  82 are extending, enhancing, or bug fixing already implemented code, use the style
  83 that is already being used so that the source is uniform and easy to
  84 follow.</a></b></p>
  85
  86 </blockquote>
  87
  88 <p>The ultimate goal of these guidelines is the increase readability and
  89 maintainability of our common source base. If you have suggestions for topics to
  90 be included, please mail them to <a
  91 href="mailto:sabre@nondot.org">Chris</a>.</p>
  92
  93 </div>
  94
  95 <!-- *********************************************************************** -->
  96 <div class="doc_section">
  97   <a name="mechanicalissues">Mechanical Source Issues</a>
  98 </div>
  99 <!-- *********************************************************************** -->
 100
 101 <!-- ======================================================================= -->
 102 <div class="doc_subsection">
 103   <a name="sourceformating">Source Code Formatting</a>
 104 </div>
 105
 106 <!-- _______________________________________________________________________ -->
 107 <div class="doc_subsubsection">
 108   <a name="scf_commenting">Commenting</a>
 109 </div>
 110
 111 <div class="doc_text">
 112
 113 <p>Comments are one critical part of readability and maintainability.  Everyone
 114 knows they should comment, so should you.  :)  Although we all should probably
 115 comment our code more than we do, there are a few very critical places that
 116 documentation is very useful:</p>
 117
 118 <b>File Headers</b>
 119
 120 <p>Every source file should have a header on it that
 121 describes the basic purpose of the file.  If a file does not have a header, it
 122 should not be checked into CVS.  Most source trees will probably have a standard
 123 file header format.  The standard format for the LLVM source tree looks like
 124 this:</p>
 125
 126 <div class="doc_code">
 127 <pre>
 128 //===-- llvm/Instruction.h - Instruction class definition -------*- C++ -*-===//
 129 //
 130 //                     The LLVM Compiler Infrastructure
 131 //
 132 // This file was developed by the LLVM research group and is distributed under
 133 // the University of Illinois Open Source License. See LICENSE.TXT for details.
 134 //
 135 //===----------------------------------------------------------------------===//
 136 //
 137 // This file contains the declaration of the Instruction class, which is the
 138 // base class for all of the VM instructions.
 139 //
 140 //===----------------------------------------------------------------------===//
 141 </pre>
 142 </div>
 143
 144 <p>A few things to note about this particular format:  The "<tt>-*- C++
 145 -*-</tt>" string on the first line is there to tell Emacs that the source file
 146 is a C++ file, not a C file (Emacs assumes .h files are C files by default).
 147 Note that this tag is not necessary in .cpp files.  The name of the file is also
 148 on the first line, along with a very short description of the purpose of the
 149 file.  This is important when printing out code and flipping though lots of
 150 pages.</p>
 151
 152 <p>The next section in the file is a concise note that defines the license that
 153 the file is released under.  This makes it perfectly clear what terms the source
 154 code can be distributed under.</p>
 155
 156 <p>The main body of the description does not have to be very long in most cases.
 157 Here it's only two lines.  If an algorithm is being implemented or something
 158 tricky is going on, a reference to the paper where it is published should be
 159 included, as well as any notes or "gotchas" in the code to watch out for.</p>
 160
 161 <b>Class overviews</b>
 162
 163 <p>Classes are one fundemental part of a good object oriented design.  As such,
 164 a class definition should have a comment block that explains what the class is
 165 used for... if it's not obvious.  If it's so completely obvious your grandma
 166 could figure it out, it's probably safe to leave it out.  Naming classes
 167 something sane goes a long ways towards avoiding writing documentation. :)</p>
 168
 169
 170 <b>Method information</b>
 171
 172 <p>Methods defined in a class (as well as any global functions) should also be
 173 documented properly.  A quick note about what it does any a description of the
 174 borderline behaviour is all that is necessary here (unless something
 175 particularly tricky or insideous is going on).  The hope is that people can
 176 figure out how to use your interfaces without reading the code itself... that is
 177 the goal metric.</p>
 178
 179 <p>Good things to talk about here are what happens when something unexpected
 180 happens: does the method return null?  Abort?  Format your hard disk?</p>
 181
 182 </div>
 183
 184 <!-- _______________________________________________________________________ -->
 185 <div class="doc_subsubsection">
 186   <a name="scf_commentformat">Comment Formatting</a>
 187 </div>
 188
 189 <div class="doc_text">
 190
 191 <p>In general, prefer C++ style (<tt>//</tt>) comments.  They take less space,
 192 require less typing, don't have nesting problems, etc.  There are a few cases
 193 when it is useful to use C style (<tt>/* */</tt>) comments however:</p>
 194
 195 <ol>
 196   <li>When writing a C code: Obviously if you are writing C code, use C style
 197       comments.  :)</li>
 198   <li>When writing a header file that may be #included by a C source file.</li>
 199   <li>When writing a source file that is used by a tool that only accepts C
 200       style comments.</li>
 201 </ol>
 202
 203 <p>To comment out a large block of code, use <tt>#if 0</tt> and <tt>#endif</tt>.
 204 These nest properly and are better behaved in general than C style comments.</p>
 205
 206 </div>
 207
 208 <!-- _______________________________________________________________________ -->
 209 <div class="doc_subsubsection">
 210   <a name="scf_includes">#include Style</a>
 211 </div>
 212
 213 <div class="doc_text">
 214
 215 <p>Immediately after the <a href="#scf_commenting">header file comment</a> (and
 216 include guards if working on a header file), the <a
 217 href="#hl_dontinclude">minimal</a> list of <tt>#include</tt>s required by the
 218 file should be listed.  We prefer these <tt>#include</tt>s to be listed in this
 219 order:</p>
 220
 221 <ol>
 222   <li><a href="#mmheader">Main Module header</a></li>
 223   <li><a href="#hl_privateheaders">Local/Private Headers</a></li>
 224   <li><tt>llvm/*</tt></li>
 225   <li><tt>llvm/Analysis/*</tt></li>
 226   <li><tt>llvm/Assembly/*</tt></li>
 227   <li><tt>llvm/Bytecode/*</tt></li>
 228   <li><tt>llvm/CodeGen/*</tt></li>
 229   <li>...</li>
 230   <li><tt>Support/*</tt></li>
 231   <li><tt>Config/*</tt></li>
 232   <li>System <tt>#includes</tt></li>
 233 </ol>
 234
 235 <p>... and each catagory should be sorted by name.</p>
 236
 237 <p><a name="mmheader">The "Main Module Header"</a> file applies to .cpp file
 238 which implement an interface defined by a .h file.  This #include should always
 239 be included <b>first</b> regardless of where it lives on the file system.  By
 240 including a header file first in the .cpp files that implement the interfaces,
 241 we ensure that the header does not have any hidden dependencies which are not
 242 explicitly #included in the header, but should be.  It is also a form of
 243 documentation in the .cpp file to indicate where the interfaces it implements
 244 are defined.</p>
 245
 246 </div>
 247
 248 <!-- _______________________________________________________________________ -->
 249 <div class="doc_subsubsection">
 250   <a name="scf_codewidth">Source Code Width</a>
 251 </div>
 252
 253 <div class="doc_text">
 254
 255 <p>Write your code to fit within 80 columns of text.  This helps those of us who
 256 like to print out code and look at your code in an xterm without resizing
 257 it.</p>
 258
 259 </div>
 260
 261 <!-- _______________________________________________________________________ -->
 262 <div class="doc_subsubsection">
 263   <a name="scf_spacestabs">Use Spaces Instead of Tabs</a>
 264 </div>
 265
 266 <div class="doc_text">
 267
 268 <p>In all cases, prefer spaces to tabs in source files.  People have different
 269 prefered indentation levels, and different styles of indentation that they
 270 like... this is fine.  What isn't is that different editors/viewers expand tabs
 271 out to different tab stops.  This can cause your code to look completely
 272 unreadable, and it is not worth dealing with.</p>
 273
 274 <p>As always, follow the <a href="#goldenrule">Golden Rule</a> above: follow the
 275 style of existing code if your are modifying and extending it.  If you like four
 276 spaces of indentation, <b>DO NOT</b> do that in the middle of a chunk of code
 277 with two spaces of indentation.  Also, do not reindent a whole source file: it
 278 makes for incredible diffs that are absolutely worthless.</p>
 279
 280 </div>
 281
 282 <!-- _______________________________________________________________________ -->
 283 <div class="doc_subsubsection">
 284   <a name="scf_indentation">Indent Code Consistently</a>
 285 </div>
 286
 287 <div class="doc_text">
 288
 289 <p>Okay, your first year of programming you were told that indentation is
 290 important.  If you didn't believe and internalize this then, now is the time.
 291 Just do it.</p>
 292
 293 </div>
 294
 295
 296 <!-- ======================================================================= -->
 297 <div class="doc_subsection">
 298   <a name="compilerissues">Compiler Issues</a>
 299 </div>
 300
 301
 302 <!-- _______________________________________________________________________ -->
 303 <div class="doc_subsubsection">
 304   <a name="ci_warningerrors">Treat Compiler Warnings Like Errors</a>
 305 </div>
 306
 307 <div class="doc_text">
 308
 309 <p>If your code has compiler warnings in it, something is wrong: you aren't
 310 casting values correctly, your have "questionable" constructs in your code, or
 311 you are doing something legitimately wrong.  Compiler warnings can cover up
 312 legitimate errors in output and make dealing with a translation unit
 313 difficult.</p>
 314
 315 <p>It is not possible to prevent all warnings from all compilers, nor is it
 316 desirable.  Instead, pick a standard compiler (like <tt>gcc</tt>) that provides
 317 a good thorough set of warnings, and stick to them.  At least in the case of
 318 <tt>gcc</tt>, it is possible to work around any spurious errors by changing the
 319 syntax of the code slightly.  For example, an warning that annoys me occurs when
 320 I write code like this:</p>
 321
 322 <div class="doc_code">
 323 <pre>
 324 if (V = getValue()) {
 325   ...
 326 }
 327 </pre>
 328 </div>
 329
 330 <p><tt>gcc</tt> will warn me that I probably want to use the <tt>==</tt>
 331 operator, and that I probably mistyped it.  In most cases, I haven't, and I
 332 really don't want the spurious errors.  To fix this particular problem, I
 333 rewrite the code like this:</p>
 334
 335 <div class="doc_code">
 336 <pre>
 337 if ((V = getValue())) {
 338   ...
 339 }
 340 </pre>
 341 </div>
 342
 343 <p>...which shuts <tt>gcc</tt> up.  Any <tt>gcc</tt> warning that annoys you can
 344 be fixed by massaging the code appropriately.</p>
 345
 346 <p>These are the <tt>gcc</tt> warnings that I prefer to enable: <tt>-Wall
 347 -Winline -W -Wwrite-strings -Wno-unused</tt></p>
 348
 349 </div>
 350
 351 <!-- _______________________________________________________________________ -->
 352 <div class="doc_subsubsection">
 353   <a name="ci_portable_code">Write Portable Code</a>
 354 </div>
 355
 356 <div class="doc_text">
 357
 358 <p>In almost all cases, it is possible and within reason to write completely
 359 portable code.  If there are cases where it isn't possible to write portable
 360 code, isolate it behind a well defined (and well documented) interface.</p>
 361
 362 <p>In practice, this means that you shouldn't assume much about the host
 363 compiler, including its support for "high tech" features like partial
 364 specialization of templates.  In fact, Visual C++ 6 could be an important target
 365 for our work in the future, and we don't want to have to rewrite all of our code
 366 to support it.</p>
 367
 368 </div>
 369
 370 <!-- _______________________________________________________________________ -->
 371 <div class="doc_subsubsection">
 372 <a name="ci_class_struct">Use of <tt>class</tt> and <tt>struct</tt> Keywords</a>
 373 </div>
 374 <div class="doc_text">
 375
 376 <p>In C++, the <tt>class</tt> and <tt>struct</tt> keywords can be used almost
 377 interchangeably. The only difference is when they are used to declare a class:
 378 <tt>class</tt> makes all members private by default while <tt>struct</tt> makes
 379 all members public by default.</p>
 380
 381 <p>Unfortunately, not all compilers follow the rules and some will generate
 382 different symbols based on whether <tt>class</tt> or <tt>struct</tt> was used to
 383 declare the symbol.  This can lead to problems at link time.</p>
 384
 385 <p>So, the rule for LLVM is to always use the <tt>class</tt> keyword, unless
 386 <b>all</b> members are public, in which case <tt>struct</tt> is allowed.</p>
 387
 388 </div>
 389
 390 <!-- *********************************************************************** -->
 391 <div class="doc_section">
 392   <a name="styleissues">Style Issues</a>
 393 </div>
 394 <!-- *********************************************************************** -->
 395
 396
 397 <!-- ======================================================================= -->
 398 <div class="doc_subsection">
 399   <a name="macro">The High Level Issues</a>
 400 </div>
 401
 402
 403 <!-- _______________________________________________________________________ -->
 404 <div class="doc_subsubsection">
 405   <a name="hl_module">A Public Header File <b>is</b> a Module</a>
 406 </div>
 407
 408 <div class="doc_text">
 409
 410 <p>C++ doesn't do too well in the modularity department.  There is no real
 411 encapsulation or data hiding (unless you use expensive protocol classes), but it
 412 is what we have to work with.  When you write a public header file (in the LLVM
 413 source tree, they live in the top level "include" directory), you are defining a
 414 module of functionality.</p>
 415
 416 <p>Ideally, modules should be completely independent of each other, and their
 417 header files should only include the absolute minimum number of headers
 418 possible. A module is not just a class, a function, or a namespace: <a
 419 href="http://www.cuj.com/articles/2000/0002/0002c/0002c.htm">it's a collection
 420 of these</a> that defines an interface.  This interface may be several
 421 functions, classes or data structures, but the important issue is how they work
 422 together.</p>
 423
 424 <p>In general, a module should be implemented with one or more <tt>.cpp</tt>
 425 files.  Each of these <tt>.cpp</tt> files should include the header that defines
 426 their interface first.  This ensure that all of the dependences of the module
 427 header have been properly added to the module header itself, and are not
 428 implicit.  System headers should be included after user headers for a
 429 translation unit.</p>
 430
 431 </div>
 432
 433 <!-- _______________________________________________________________________ -->
 434 <div class="doc_subsubsection">
 435   <a name="hl_dontinclude">#include as Little as Possible</a>
 436 </div>
 437
 438 <div class="doc_text">
 439
 440 <p><tt>#include</tt> hurts compile time performance.  Don't do it unless you
 441 have to, especially in header files.</p>
 442
 443 <p>But wait, sometimes you need to have the definition of a class to use it, or
 444 to inherit from it.  In these cases go ahead and #include that header file.  Be
 445 aware however that there are many cases where you don't need to have the full
 446 definition of a class.  If you are using a pointer or reference to a class, you
 447 don't need the header file.  If you are simply returning a class instance from a
 448 prototyped function or method, you don't need it.  In fact, for most cases, you
 449 simply don't need the definition of a class... and not <tt>#include</tt>'ing
 450 speeds up compilation.</p>
 451
 452 <p>It is easy to try to go too overboard on this recommendation, however.  You
 453 <b>must</b> include all of the header files that you are using, either directly
 454 or indirectly (through another header file).  To make sure that you don't
 455 accidently forget to include a header file in your module header, make sure to
 456 include your module header <b>first</b> in the implementation file (as mentioned
 457 above).  This way there won't be any hidden dependencies that you'll find out
 458 about later...</p>
 459
 460 </div>
 461
 462 <!-- _______________________________________________________________________ -->
 463 <div class="doc_subsubsection">
 464   <a name="hl_privateheaders">Keep "internal" Headers Private</a>
 465 </div>
 466
 467 <div class="doc_text">
 468
 469 <p>Many modules have a complex implementation that causes them to use more than
 470 one implementation (<tt>.cpp</tt>) file.  It is often tempting to put the
 471 internal communication interface (helper classes, extra functions, etc) in the
 472 public module header file.  Don't do this.  :)</p>
 473
 474 <p>If you really need to do something like this, put a private header file in
 475 the same directory as the source files, and include it locally.  This ensures
 476 that your private interface remains private and undisturbed by outsiders.</p>
 477
 478 <p>Note however, that it's okay to put extra implementation methods a public
 479 class itself... just make them private (or protected), and all is well.</p>
 480
 481 </div>
 482
 483 <!-- ======================================================================= -->
 484 <div class="doc_subsection">
 485   <a name="micro">The Low Level Issues</a>
 486 </div>
 487
 488
 489 <!-- _______________________________________________________________________ -->
 490 <div class="doc_subsubsection">
 491   <a name="hl_assert">Assert Liberally</a>
 492 </div>
 493
 494 <div class="doc_text">
 495
 496 <p>Use the "<tt>assert</tt>" function to its fullest.  Check all of your
 497 preconditions and assumptions, you never know when a bug (not neccesarily even
 498 yours) might be caught early by an assertion, which reduces debugging time
 499 dramatically.  The "<tt>&lt;cassert&gt;</tt>" header file is probably already
 500 included by the header files you are using, so it doesn't cost anything to use
 501 it.</p>
 502
 503 <p>To further assist with debugging, make sure to put some kind of error message
 504 in the assertion statement (which is printed if the assertion is tripped). This
 505 helps the poor debugging make sense of why an assertion is being made and
 506 enforced, and hopefully what to do about it.  Here is one complete example:</p>
 507
 508 <div class="doc_code">
 509 <pre>
 510 inline Value *getOperand(unsigned i) {
 511   assert(i &lt; Operands.size() &amp;&amp; "getOperand() out of range!");
 512   return Operands[i];
 513 }
 514 </pre>
 515 </div>
 516
 517 <p>Here are some examples:</p>
 518
 519 <div class="doc_code">
 520 <pre>
 521 assert(Ty-&gt;isPointerType() &amp;&amp; "Can't allocate a non pointer type!");
 522
 523 assert((Opcode == Shl || Opcode == Shr) &amp;&amp; "ShiftInst Opcode invalid!");
 524
 525 assert(idx &lt; getNumSuccessors() &amp;&amp; "Successor # out of range!");
 526
 527 assert(V1.getType() == V2.getType() &amp;&amp; "Constant types must be identical!");
 528
 529 assert(isa&lt;PHINode&gt;(Succ-&gt;front()) &amp;&amp; "Only works on PHId BBs!");
 530 </pre>
 531 </div>
 532
 533 <p>You get the idea...</p>
 534
 535 </div>
 536
 537
 538 <!-- _______________________________________________________________________ -->
 539 <div class="doc_subsubsection">
 540   <a name="hl_preincrement">Prefer Preincrement</a>
 541 </div>
 542
 543 <div class="doc_text">
 544
 545 <p>Hard fast rule: Preincrement (<tt>++X</tt>) may be no slower than
 546 postincrement (<tt>X++</tt>) and could very well be a lot faster than it.  Use
 547 preincrementation whenever possible.</p>
 548
 549 <p>The semantics of postincrement include making a copy of the value being
 550 incremented, returning it, and then preincrementing the "work value".  For
 551 primitive types, this isn't a big deal... but for iterators, it can be a huge
 552 issue (for example, some iterators contains stack and set objects in them...
 553 copying an iterator could invoke the copy ctor's of these as well).  In general,
 554 get in the habit of always using preincrement, and you won't have a problem.</p>
 555
 556 </div>
 557
 558 <!-- _______________________________________________________________________ -->
 559 <div class="doc_subsubsection">
 560   <a name="hl_avoidendl">Avoid std::endl</a>
 561 </div>
 562
 563 <div class="doc_text">
 564
 565 <p>The <tt>std::endl</tt> modifier, when used with iostreams outputs a newline
 566 to the output stream specified.  In addition to doing this, however, it also
 567 flushes the output stream.  In other words, these are equivalent:</p>
 568
 569 <div class="doc_code">
 570 <pre>
 571 std::cout &lt;&lt; std::endl;
 572 std::cout &lt;&lt; '\n' &lt;&lt; std::flush;
 573 </pre>
 574 </div>
 575
 576 <p>Most of the time, you probably have no reason to flush the output stream, so
 577 it's better to use a literal <tt>'\n'</tt>.</p>
 578
 579 </div>
 580
 581 <!-- _______________________________________________________________________ -->
 582 <div class="doc_subsubsection">
 583   <a name="hl_exploitcpp">Exploit C++ to its Fullest</a>
 584 </div>
 585
 586 <div class="doc_text">
 587
 588 <p>C++ is a powerful language.  With a firm grasp on its capabilities, you can
 589 make write effective, consise, readable and maintainable code all at the same
 590 time.  By staying consistent, you reduce the amount of special cases that need
 591 to be remembered.  Reducing the total number of lines of code you write is a
 592 good way to avoid documentation, and avoid giving bugs a place to hide.</p>
 593
 594 <p>For these reasons, come to know and love the contents of your local
 595 &lt;algorithm&gt; header file.  Know about &lt;functional&gt; and what it can do
 596 for you.  C++ is just a tool that wants you to master it. :)</p>
 597
 598 </div>
 599
 600 <!-- *********************************************************************** -->
 601 <div class="doc_section">
 602   <a name="seealso">See Also</a>
 603 </div>
 604 <!-- *********************************************************************** -->
 605
 606 <div class="doc_text">
 607
 608 <p>A lot of these comments and recommendations have been culled for other
 609 sources.  Two particularly important books for our work are:</p>
 610
 611 <ol>
 612
 613 <li><a href="http://www.aw-bc.com/catalog/academic/product/0,1144,0201310155,00.html">Effective
 614 C++</a> by Scott Meyers.  There is an online version of the book (only some
 615 chapters though) <a
 616 href="http://www.awlonline.com/cseng/meyerscddemo/">available as well</a>.  Also
 617 interesting and useful are "More Effective C++" and "Effective STL" by the same
 618 author.</li>
 619
 620 <li><a href="http://cseng.aw.com/book/0,3828,0201633620,00.html">Large-Scale C++
 621 Software Design</a> by John Lakos</li>
 622
 623 </ol>
 624
 625 <p>If you get some free time, and you haven't read them: do so, you might learn
 626 something. :)</p>
 627
 628 </div>
 629
 630 <!-- *********************************************************************** -->
 631
 632 <hr>
 633 <address>
 634   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 635   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 636   <a href="http://validator.w3.org/check/referer"><img
 637   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 638
 639   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
 640   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 641   Last modified: $Date$
 642 </address>
 643
 644 </body>
 645 </html>