summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorlevine <levine@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>1999-05-03 14:32:33 +0000
committerlevine <levine@ae88bc3d-4319-0410-8dbf-d08b4c9d3795>1999-05-03 14:32:33 +0000
commit334cfa1cd30309bde6a0cb6560cfcdeaef4bb6f4 (patch)
treedd2b1cc09873fad1ad5a4471f2a4201a57fac2da /docs
parente9a7a7a4529121d89385598f5b2d2aa6f19bff4c (diff)
downloadATCD-334cfa1cd30309bde6a0cb6560cfcdeaef4bb6f4.tar.gz
added guideline to put spaces around comment delimiters. Thanks to
Chris Gill for suggesting this.
Diffstat (limited to 'docs')
-rw-r--r--docs/ACE-guidelines.html11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/ACE-guidelines.html b/docs/ACE-guidelines.html
index 0de2ca1a752..62cf5cc69ba 100644
--- a/docs/ACE-guidelines.html
+++ b/docs/ACE-guidelines.html
@@ -140,16 +140,21 @@ bgcolor="#ffffff">
#endif /* ACE_HAS_THREADS */
</pre><p>
+ <li>Be sure to put spaces around comment delimiters, e.g.,
+ <strong><code>char * /* foo */</code></strong> instead of
+ <strong><code>char */*foo*/</code></strong>. MS VC++
+ complains otherwise.<p>
+
<li>Always insert a <strong><code>/**/</code></strong> between an
<strong><code>#include</code></strong> and
<strong><code>filename</code></strong>, as shown in the above
example. This avoids dependency problems with Visual C++.<p>
- <li>Be very careful with names of macros and enum values. It's
- always best to prefix them with something like <code>ACE_</code>
+ <li>Be very careful with names of macros, enum values, and variables
+ It's always best to prefix them with something like <code>ACE_</code>
or <code>TAO_</code>. There are too many system headers out
there that #define <code>OK</code>, <code>SUCCESS</code>,
- <code>ERROR</code>, and so on.<p>
+ <code>ERROR</code>, <code>index</code>, and so on.<p>
<li>Try to centralize <code>#ifdefs</code> with <code>typedefs</code>
and <code>#defines</code>. For example, use this: