6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-08-03 00:29:31 +00:00
Code Issues Projects Releases Wiki Activity

Documentation which contains smileys won't be taken seriously by some people.

Browse Source 
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@18474 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Misha Brukman 2004-12-04 00:32:12 +00:00
parent ff52f9c91d
commit 3b53a26191
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/CodingStandards.html
View File

@ -111,7 +111,7 @@ href="mailto:sabre@nondot.org">Chris</a>.</p>
<div class="doc_text"> <div class="doc_text">
<p>Comments are one critical part of readability and maintainability. Everyone <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 comment our code more than we do, there are a few very critical places that
documentation is very useful:</p> 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 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 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 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> <b>Method information</b>
@ -194,7 +194,7 @@ when it is useful to use C style (<tt>/* */</tt>) comments however:</p>
<ol> <ol>
<li>When writing a C code: Obviously if you are writing C code, use C style <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 <li>When writing a header file that may be <tt>#include</tt>d by a C source
file.</li> file.</li>
<li>When writing a source file that is used by a tool that only accepts C <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 <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 one implementation (<tt>.cpp</tt>) file. It is often tempting to put the
internal communication interface (helper classes, extra functions, etc) in 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 <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 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 <p>For these reasons, come to know and love the contents of your local
<tt>&lt;algorithm&gt;</tt> header file. Know about <tt>&lt;functional&gt;</tt> <tt>&lt;algorithm&gt;</tt> header file. Know about <tt>&lt;functional&gt;</tt>
and what it can do for you. C++ is just a tool that wants you to master it. and what it can do for you. C++ is just a tool that wants you to master it.</p>
:)</p>
</div> </div>
@ -625,7 +624,7 @@ Software Design</a> by John Lakos</li>
</ol> </ol>
<p>If you get some free time, and you haven't read them: do so, you might learn <p>If you get some free time, and you haven't read them: do so, you might learn
something. :)</p> something.</p>
</div> </div>