User Tools

Site Tools


coding_style

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
coding_style [2018/05/22 10:33] – external edit 127.0.0.1coding_style [2022/09/16 16:00] – [Suggestions] ddecoeyer
Line 5: Line 5:
  
 ====== C/C++ ====== ====== C/C++ ======
 +
 +An Eclipse configuration file is available in the Quimesis Drive ([[https://drive.google.com/drive/u/1/folders/15kA1L8lqPqv_KUtLvTHGBcdgA3z_MHsB | 06 Documentation > Doc info]] > ''quimesis_coding_rules_for_eclipse.xml''); refer to the ''Development environment'' document in the same directory for how to use it.
 ===== Indentation ===== ===== Indentation =====
  
Line 101: Line 103:
   * Use Doxygen syntax ( http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html )   * Use Doxygen syntax ( http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html )
   * Prefer self-explanatory names over extended comments.   * Prefer self-explanatory names over extended comments.
- +  * README files could be necessary; in which case it is recommended to use [[https://en.wikipedia.org/wiki/Markdown | Markdown]] for its formatting
 ====== Python ====== ====== Python ======
  
Line 151: Line 152:
  
 A standard-compliant UPnP library to build devices and control points. A standard-compliant UPnP library to build devices and control points.
 +
 +===== Mosquitto (MQTT) =====
 +
 +http://mosquitto.org/
 +
 +Ubuntu package to install: ''libmosquitto-dev''
 +
 +
 +===== JSON =====
 +
 +https://github.com/open-source-parsers/jsoncpp
 +
 +Ubuntu package to install: ''libjsoncpp-dev''
 +
 +===== Serial port =====
 +
 +http://libserial.sourceforge.net/
 +
 +Ubuntu package to install: ''libserial-dev''
 +
 +===== Suggestions =====
 +
 +  * switch case indentation:
 +<code cpp>
 +switch(<var>)
 +{
 +    case <value>:
 +    {
 +        <code>
 +        break;
 +    }
 +}
 +</code>
coding_style.txt · Last modified: 2022/09/16 18:16 by ddecoeyer