Codebase list kissplice / run/62229802-bf59-4a76-aefa-d1b4be593c0f/upstream README.NamingConventions
run/62229802-bf59-4a76-aefa-d1b4be593c0f/upstream

Tree @run/62229802-bf59-4a76-aefa-d1b4be593c0f/upstream (Download .tar.gz)

README.NamingConventions @run/62229802-bf59-4a76-aefa-d1b4be593c0f/upstreamraw · history · blame

********************* CONVENTIONS **************************

************** For class : 
 two classes skeletons are provided (comments included )


************** Coding convention

1/ CamelCase is used.
No underscore, compound words are joined. 

Within the compound, each element starts with a capital letter 
(e.g. : CamelCase or camelCase)

a ) Class names start with an uppercase.
    ClassName
    
    Files should be named according to the class they implement.
    
b ) Class methods start with a lowercase. 
Please use and abuse of the prefix get and/or set.
    classMethod


c ) For attributes: 
    if public: 
     classAttribute;
    if protected or private: prefix it with an underscore
     _classAttribute;

d) For files inclusion (#ifndef), add the suffixe _H
#ifndef MYCLASS_H
#define MYCLASS_H
  ....

2/ Use transparent names  

Also to avoid confusion between number of X & X number :

* nbX for the number of instances of X
* numX for the index of the X object wanted

3/ For brackets:
Start them on a new line,
to avoid: 
  maMethod(){
    ...
  }

to do: 
  maMethod()
  {
    ...
  }

4/ Please use a two spaces indentation (and not tabulation )


**************  Documentation

A Doxygen documentation has been set up.

See http://www.stack.nl/~dimitri/doxygen/ for more information.

Any new method or class should be commented using Doxygen.

 Please think of commenting ancient methods and classes.