|
Packit Service |
8a8a03 |
Coding style used in abrt
|
|
Packit Service |
8a8a03 |
=================================
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
1. Class
|
|
Packit Service |
8a8a03 |
--------
|
|
Packit Service |
8a8a03 |
1.1 Class has to start with 'C'
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
1.2 Method
|
|
Packit Service |
8a8a03 |
-----------
|
|
Packit Service |
8a8a03 |
1.2.1 method starts witch a capital letter
|
|
Packit Service |
8a8a03 |
1.2.2 method name can contain only letters
|
|
Packit Service |
8a8a03 |
1.2.3 parameter of a method has to start with the letter 'p'
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
1.3 Attribute
|
|
Packit Service |
8a8a03 |
-------------
|
|
Packit Service |
8a8a03 |
1.3.1 non-float attribute has to start with "m_n"
|
|
Packit Service |
8a8a03 |
1.3.2 float attribute has to start with "m_f"
|
|
Packit Service |
8a8a03 |
1.3.3 double attribute has to start with "m_d"
|
|
Packit Service |
8a8a03 |
1.3.4 bool attribute has to start with "m_b"
|
|
Packit Service |
8a8a03 |
1.3.5 string/char attribute has to start with "m_s"
|
|
Packit Service |
8a8a03 |
1.3.6 pointer attribute has to start with "m_p"
|
|
Packit Service |
8a8a03 |
1.3.7 template attribute has to start with a template name "m_map"
|
|
Packit Service |
8a8a03 |
1.3.8 otherwise "m_"
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
2. Type
|
|
Packit Service |
8a8a03 |
-------
|
|
Packit Service |
8a8a03 |
2.1 every type has to end with "_t"
|
|
Packit Service |
8a8a03 |
2.2 types created from templates has to start with a template name
|
|
Packit Service |
8a8a03 |
2.3 words in a type has to be separated with "_"
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
3. Statement
|
|
Packit Service |
8a8a03 |
------------
|
|
Packit Service |
8a8a03 |
3.1 "if", "while" and "for" has to have {} every time.
|
|
Packit Service |
8a8a03 |
3.2 { is on the new line every time
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
4. Example
|
|
Packit Service |
8a8a03 |
----------
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
typedef std::map<int, int> map_new_type_t;
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
class CAwesomeClass
|
|
Packit Service |
8a8a03 |
{
|
|
Packit Service |
8a8a03 |
private:
|
|
Packit Service |
8a8a03 |
map_new_type_t m_NewType;
|
|
Packit Service |
8a8a03 |
std::string m_sName;
|
|
Packit Service |
8a8a03 |
COtherClass* m_pOtherClass;
|
|
Packit Service |
8a8a03 |
void PrivateFunction(int pParameter);
|
|
Packit Service |
8a8a03 |
public:
|
|
Packit Service |
8a8a03 |
CAwesomeClass(std::string pName) :
|
|
Packit Service |
8a8a03 |
m_sName(pName), m_pOtherClass(NULL)
|
|
Packit Service |
8a8a03 |
{}
|
|
Packit Service |
8a8a03 |
};
|
|
Packit Service |
8a8a03 |
|
|
Packit Service |
8a8a03 |
void CAwesomeClass::PrivateFunction(int pParameter)
|
|
Packit Service |
8a8a03 |
{
|
|
Packit Service |
8a8a03 |
if (pParameter != "")
|
|
Packit Service |
8a8a03 |
{
|
|
Packit Service |
8a8a03 |
// do something
|
|
Packit Service |
8a8a03 |
}
|
|
Packit Service |
8a8a03 |
else
|
|
Packit Service |
8a8a03 |
{
|
|
Packit Service |
8a8a03 |
// do something else
|
|
Packit Service |
8a8a03 |
}
|
|
Packit Service |
8a8a03 |
}
|