Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-08-14 00:43:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update coding style

Browse source
This commit is contained in:
Gregory Nutt 2015-07-28 20:17:19 -06:00
parent 8def63e192
commit 02afdddebe
1 changed files with 17 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

18
Documentation/NuttXCCodingStandard.html
View file

@ -12,7 +12,7 @@
<h1><big><font color="#3c34ec">
<i>NuttX C Coding Standard</i>
</font></big></h1>
<p>Last Updated: March 9, 2014</p>
<p>Last Updated: July 28, 2015</p>
</td>
</tr>
</table>
@ -382,6 +382,22 @@
<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>
<b>Line Spacing</b>
A single blank line should precede and follow each comment.