docs: update code style
This commit is contained in:
@@ -1,14 +1,16 @@
|
|||||||
Code formating and ordering
|
Code formating and ordering
|
||||||
|
===========================
|
||||||
|
|
||||||
* The source file will keep and order of methods. The order will be as
|
+ The source file will keep and order of methods. The order will be as
|
||||||
following:
|
following:
|
||||||
1. Private functions will go first.
|
1. Private functions will go first.
|
||||||
2. class_init and init will go second.
|
2. class_init and init will go second.
|
||||||
3. vfuncs implementations will go third.
|
3. vfuncs implementations will go third.
|
||||||
4. Public API will go fourth
|
4. Public API will go fourth
|
||||||
|
|
||||||
* Methods naming will be according to:
|
+ Methods naming will be according to:
|
||||||
1. Private methods will have no prefix
|
1. Private methods will have no prefix
|
||||||
2. vfuncs and public API will have the right prefix
|
2. vfuncs and public API will have the right prefix
|
||||||
|
|
||||||
* The methods prototype will always be placed at the top of the source.
|
+ The methods prototype will always be placed at the top of the source, in the
|
||||||
|
same order as their implementation below.
|
||||||
|
|||||||
Reference in New Issue
Block a user