sergiotarxz/nuttx
sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update the C coding standard.

Browse Source
This commit is contained in:
Gregory Nutt 2017-05-06 15:18:39 -06:00
parent 0b2fb5a396
commit e4b71a06bb
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/NuttXCCodingStandard.html
View File

@ -12,7 +12,7 @@
<h1><big><font color="#3c34ec"> <h1><big><font color="#3c34ec">
<i>NuttX C Coding Standard</i> <i>NuttX C Coding Standard</i>
</font></big></h1> </font></big></h1>
<p>Last Updated: April 18, 2017</p> <p>Last Updated: May 6, 2017</p>
</td> </td>
</tr> </tr>
</table> </table>
@ -405,8 +405,11 @@
<p> <p>
<b>Line Spacing</b> <b>Line Spacing</b>
A single blank line should precede and follow each comment. A single blank line should precede and follow each comment.
The only exception is for the file header block comment that begins on line one; The only exceptions are (1) for the file header block comment that begins on line one;
there is no preceding blank line in that case. there is no preceding blank line in that case.
And (2) for conditional compilation.
Conditional compilation should include the conditional logic <i>and</i> all comments associated with the conditional logic.
In this case, the blank line appears <i>before</i> the conditional, not after it.
</p> </p>
<center><table width="60%" border=1> <center><table width="60%" border=1>
<tr><td bgcolor="white"> <tr><td bgcolor="white">
@ -416,6 +419,12 @@
a = b; a = b;
/* set b equal to c */ /* set b equal to c */
b = c; b = c;
/* Do the impossible */
#ifdef CONFIG_THE_IMPOSSIBLE
the_impossible();
#endif
</ul></pre></font> </ul></pre></font>
</td></tr> </td></tr>
<tr><td bgcolor="white"> <tr><td bgcolor="white">
@ -430,6 +439,11 @@
b = c; b = c;
#ifdef CONFIG_THE_IMPOSSIBLE
/* Do the impossible */
the_impossible();
#endif
</ul></pre></font> </ul></pre></font>
</td></tr> </td></tr>
</table></center> </table></center>
@ -1611,7 +1625,7 @@ enum xyz_state_e
</li> </li>
<li> <li>
<b>Lowercase Exceptions</b>. <b>Lowercase Exceptions</b>.
There are3 a few lower case values in NuttX macro names. Such as a lower-case <code>p</code> for a period or decimal point (such as <code>VOLTAGE_3p3V</code>). There are a few lower case values in NuttX macro names. Such as a lower-case <code>p</code> for a period or decimal point (such as <code>VOLTAGE_3p3V</code>).
I have also used lower-case <code>v</code> for a version number (such as <code>CONFIG_NET_IPv6</code>). I have also used lower-case <code>v</code> for a version number (such as <code>CONFIG_NET_IPv6</code>).
However, these are exceptions to the rule rather than illustrating a rule. However, these are exceptions to the rule rather than illustrating a rule.
</li> </li>