Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-01-26 14:36:18 -05:00
Code Issues Packages Projects Releases Wiki Activity

CodingStyle changed

Browse Source 
Language-specific guidelines
This commit is contained in:
Joanna Rutkowska 2013-04-18 13:50:51 +00:00
parent 76d37a1c92
commit f472ddbc33
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CodingStyle.md
View File

@ -131,14 +131,18 @@ Security coding guidelines
Python-specific guidelines
--------------------------
TODO
- Please follow the guidlines [​here](http://www.python.org/dev/peps/pep-0008/), unless they were in conflict with what is written on this page.
C-specific guidelines
---------------------
C and C++ specific guidelines
-----------------------------
TODO
- Do not place code in `*.h` files.
- Use `const` whenever possible, e.g. in function arguments passed via pointers.
- Do not mix procedural and objective code together -- if you write in C++, use classes and objects.
- Think about classes hierarchy, before start implementing specific methods.
C++-specific guideline
----------------------
Bash-specific guidelines
------------------------
- Avoid writing scripts in bash whenever possible. Use python instead. Bash-scripts are Unix-specific and will not work under Windows VMs, or in Windows admin domain, or Windows gui domain.
TODO