Editing Miniature/Policies
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 11: | Line 11: | ||
Note: the current code violates this style. We will fix it. | Note: the current code violates this style. We will fix it. | ||
- | We mostly | + | We mostly try to follow the offical Qt Coding Guidelines, but with some exceptions. |
* We use whitespaces over tabs. | * We use whitespaces over tabs. | ||
* Max. length of a source code line is 120 characters. | * Max. length of a source code line is 120 characters. | ||
Line 25: | Line 25: | ||
* Use Qt containers over std containers. | * Use Qt containers over std containers. | ||
- | + | == Advanced Coding Style == | |
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | + | ||
- | == Advanced | + | |
* Signal and slot connections should be easy to read, as they are a constant source of bugs: | * Signal and slot connections should be easy to read, as they are a constant source of bugs: | ||
Line 65: | Line 52: | ||
* Use const refs for arguments when possible, even if the type is COW (copy-on-write, for example QString). | * Use const refs for arguments when possible, even if the type is COW (copy-on-write, for example QString). | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
- | |||
* If you store a pointer to an object over which you do not intend to take ownership, then wrap this pointer in a QPointer: | * If you store a pointer to an object over which you do not intend to take ownership, then wrap this pointer in a QPointer: | ||
Line 90: | Line 61: | ||
** Details: | ** Details: | ||
- | *** QPointers keep track of object deletion and set all referring QPointers to zero, preventing dangling pointers. Especially when using signals & slots, this is an often (and sometimes hard to spot!) source of bugs. With QPointers, you can wrap your code with | + | *** QPointers keep track of object deletion and set all referring QPointers to zero, preventing dangling pointers. Especially when using signals & slots, this is an often (and sometimes hard to spot!) source of bugs. With QPointers, you can wrap your code with guards like so: |
if (m_member) | if (m_member) | ||
{ | { | ||
// Do sth with m_member object. | // Do sth with m_member object. | ||
- | // This block *never* gets executed | + | // This block *never* gets executed if m_meber was deleted elsewhere. |
} | } | ||
* Assign 0 to pointers after deletion (or use QPointers). | * Assign 0 to pointers after deletion (or use QPointers). | ||
* Always initialize type primitives (e.g., pointers) in the constructor's initializer list. | * Always initialize type primitives (e.g., pointers) in the constructor's initializer list. | ||
- | |||
== How to keep code testable (and hopefully, mostly bugfree) == | == How to keep code testable (and hopefully, mostly bugfree) == |
Learn more about Contributing to the wiki.