diff options
| author | Misha Brukman <brukman+llvm@gmail.com> | 2004-12-04 00:32:12 +0000 |
|---|---|---|
| committer | Misha Brukman <brukman+llvm@gmail.com> | 2004-12-04 00:32:12 +0000 |
| commit | 3b53a26191dd0cb951dd8d551586c89582457428 (patch) | |
| tree | 6b1a4bbc57987df1b9ed952b6866702b3b2f68ec /docs/CodingStandards.html | |
| parent | ff52f9c91db7d0a4874a9569ebc88f3e70940a25 (diff) | |
| download | external_llvm-3b53a26191dd0cb951dd8d551586c89582457428.zip external_llvm-3b53a26191dd0cb951dd8d551586c89582457428.tar.gz external_llvm-3b53a26191dd0cb951dd8d551586c89582457428.tar.bz2 | |
Documentation which contains smileys won't be taken seriously by some people.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@18474 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CodingStandards.html')
| -rw-r--r-- | docs/CodingStandards.html | 13 |
1 files changed, 6 insertions, 7 deletions
diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index b5946a4..35ead31 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -111,7 +111,7 @@ href="mailto:sabre@nondot.org">Chris</a>.</p> <div class="doc_text"> <p>Comments are one critical part of readability and maintainability. Everyone -knows they should comment, so should you. :) Although we all should probably +knows they should comment, so should you. Although we all should probably comment our code more than we do, there are a few very critical places that documentation is very useful:</p> @@ -164,7 +164,7 @@ included, as well as any notes or "gotchas" in the code to watch out for.</p> a class definition should have a comment block that explains what the class is used for... if it's not obvious. If it's so completely obvious your grandma could figure it out, it's probably safe to leave it out. Naming classes -something sane goes a long ways towards avoiding writing documentation. :)</p> +something sane goes a long ways towards avoiding writing documentation.</p> <b>Method information</b> @@ -194,7 +194,7 @@ when it is useful to use C style (<tt>/* */</tt>) comments however:</p> <ol> <li>When writing a C code: Obviously if you are writing C code, use C style - comments. :)</li> + comments.</li> <li>When writing a header file that may be <tt>#include</tt>d by a C source file.</li> <li>When writing a source file that is used by a tool that only accepts C @@ -470,7 +470,7 @@ about later...</p> <p>Many modules have a complex implementation that causes them to use more than one implementation (<tt>.cpp</tt>) file. It is often tempting to put the internal communication interface (helper classes, extra functions, etc) in the -public module header file. Don't do this. :)</p> +public module header file. Don't do this.</p> <p>If you really need to do something like this, put a private header file in the same directory as the source files, and include it locally. This ensures @@ -594,8 +594,7 @@ good way to avoid documentation, and avoid giving bugs a place to hide.</p> <p>For these reasons, come to know and love the contents of your local <tt><algorithm></tt> header file. Know about <tt><functional></tt> -and what it can do for you. C++ is just a tool that wants you to master it. -:)</p> +and what it can do for you. C++ is just a tool that wants you to master it.</p> </div> @@ -625,7 +624,7 @@ Software Design</a> by John Lakos</li> </ol> <p>If you get some free time, and you haven't read them: do so, you might learn -something. :)</p> +something.</p> </div> |