alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: update style guide

Browse Source
This commit is contained in:
Ivan Grokhotkov 2016-11-03 19:07:41 +08:00
parent b717e44eb2
commit 4d3ed9efde
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/style-guide.rst
View File

@ -3,7 +3,7 @@ Espressif IoT Development Framework Style Guide
About this guide About this guide
~~~~~~~~~~~~~~~~ ----------------
Purpose of this style guide is to encourage use of common coding practices within the ESP-IDF. Purpose of this style guide is to encourage use of common coding practices within the ESP-IDF.
@ -14,15 +14,15 @@ We try to keep rules simple enough, which means that they can not cover all pote
When doing modifications to third-party code used in ESP-IDF, follow the way that particular project is written. That will help propose useful changes for merging into upstream project. When doing modifications to third-party code used in ESP-IDF, follow the way that particular project is written. That will help propose useful changes for merging into upstream project.
C code formatting C code formatting
~~~~~~~~~~~~~~~~~ -----------------
Indentation Indentation
----------- ^^^^^^^^^^^
Use 4 spaces for each indentation level. Don't use tabs for indentation. Configure the editor to emit 4 spaces each time you press tab key. Use 4 spaces for each indentation level. Don't use tabs for indentation. Configure the editor to emit 4 spaces each time you press tab key.
Vertical space Vertical space
-------------- ^^^^^^^^^^^^^^
Place one empty line between functions. Don't begin or end a function with an empty line. Place one empty line between functions. Don't begin or end a function with an empty line.
:: ::
@ -44,7 +44,7 @@ Place one empty line between functions. Don't begin or end a function with an em
} }
Horizontal space Horizontal space
---------------- ^^^^^^^^^^^^^^^^
Always add single space after conditional and loop keywords:: Always add single space after conditional and loop keywords::
@ -93,7 +93,7 @@ Never add trailing whitespace at the end of the line.
Braces Braces
------ ^^^^^^
- Function definition should have a brace on a separate line:: - Function definition should have a brace on a separate line::
@ -112,14 +112,13 @@ Braces
if (condition) { if (condition) {
do_one(); do_one();
} } else if (other_condition) {
else if (other_condition) {
do_two(); do_two();
} }
Comments Comments
-------- ^^^^^^^^
Use ``//`` for single line comments. For multi-line comments it is okay to use either ``//`` on each line or a ``/* */`` block. Use ``//`` for single line comments. For multi-line comments it is okay to use either ``//`` on each line or a ``/* */`` block.
@ -160,7 +159,7 @@ Although not directly related to formatting, here are a few notes about using co
Formatting your code Formatting your code
-------------------- ^^^^^^^^^^^^^^^^^^^^
You can use ``astyle`` program to format your code according to the above recommendations. You can use ``astyle`` program to format your code according to the above recommendations.
@ -170,13 +169,18 @@ To re-format a file, run::
tools/format.sh components/my_component/file.c tools/format.sh components/my_component/file.c
Structure and naming Documenting code
~~~~~~~~~~~~~~~~~~~~ ----------------
Please see the guide here: `Documenting Code <documenting-code.rst>`_.
Structure and naming
--------------------
To be written.
Language features Language features
~~~~~~~~~~~~~~~~~ -----------------
To be written. To be written.