Auryn simulator

Simulator for spiking neural networks with synaptic plasticity

User Tools

Site Tools


manual:coding_style_guide

Naming conventions

Overall the Auryn code should follow Googles naming conventions because there seems to be to some degree a consensus on those. https://google.github.io/styleguide/cppguide.html

However, currently the code only enforces these conventions in part. Here are some naming conventions in Auryn which seem to have emerged over the years. Most of them are in line with the Google style. The most important deviation concerns file names which are so far all in CamelCase.

Variable names in the code should be named all lower case with underscores_where_necessary.

Class names should be in CamelCase starting with a capital letter. Classes should be defined in their own .h .cpp file combination which should carry the same names and case.

Class instances either variable case or camel case with the first letter being a small letter.

Macro names ALL_CAPS_WITH_UNDERSCORES

manual/coding_style_guide.txt · Last modified: 2018/05/18 17:08 by zenke