mirror of
https://github.com/apache/nuttx.git
synced 2026-06-05 07:12:54 +08:00
Update coding style
This commit is contained in:
@@ -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: March 9, 2014</p>
|
<p>Last Updated: July 28, 2015</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
@@ -382,6 +382,22 @@
|
|||||||
|
|
||||||
<h2><a name="comments">1.3 Comments</a></h2>
|
<h2><a name="comments">1.3 Comments</a></h2>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<b>General</b>.
|
||||||
|
Within a comment, the text must be standard English conforming to standard English rules or grammar and spelling (US English spelling).
|
||||||
|
Of course, this is not the place to summarize all English grammar, but as examples:
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
All sentences should begin with an upper-case character and end with either '.', '?', or '!'.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
Sentence fragments and phrases are generally treated the same as sentences.
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
The punctuation '.' and ':' is followed by two spaces; the punctuation ',' and ';' is followed by a single space.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
<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.
|
||||||
|
|||||||
Reference in New Issue
Block a user