hyperion.ng/CODING_STYLE.md
redPanther d679affeb4 Leddevice rework2 (#193)
* commit debug code to save it due to merge

* migrate first devices to new device registry and configure on runtime

* fadecandy and rs232 resets device if config is set

* try to hunt crash on osx

* test commit if this works with osx

* refactor spi devices

* cleanup

* refactor leddevices file, tinkerforge and ws2812b

* refactor raw usb devices

* refactor udp devices

* - add tpm2net driver
- remove old udp driver from build (files left in place for reference for new udp driver)
- json serverinfo shows available leddevices

* finish rework part 2 of leddevices

* add schemas for leddevices.
currently only compiled in, but not usedx
2016-08-23 20:07:12 +02:00

950 B

Please use the following code style/guidelines

  • use QT wherever it's possible (except there is a good reason)
  • use unix line endings (not windows)
  • indent your code with TABs instead of spaces
  • your files should end with a newline
  • names are camel case
  • use utf8 file encoding (ANSI encoding is strictly forbidden!)
  • use speaking names for variables.
  • avoid code dups -> if you write similar code blocks more the 2 times -> refactoring!
  • avoid compiler macros (#ifdef #define ...) where possible
  • class member variables must prefixed with underscore int _myMemberVar
  • follow this rule for curly brackets
bad:
if (conditon) {
	code
}

good:
if (condition)
{
	code
}
  • initializer list on constructors:
bad:
MyClass::MyClass()
	: myVarA(0), myVarB("eee"), myVarC(true)
{
}

MyClass::MyClass() : myVarA(0),
	myVarB("eee"),
	myVarC(true)
{
}

good:
MyClass::MyClass()
	: myVarA(0)
	, myVarB("eee")
	, myVarC(true)
{
}