Hintzelab/MABE

Naming conventions

cgnitash opened this issue · 3 comments

cgnitash commented

Since the code base has been around a long time, there have been a number of naming conventions, and now it's all somewhat jumbled up.

Here's a proposal for fixing the naming conventions. We don't have to apply these changes to existing code in any hurry, but new code can follow the convention, making it much easier to read. The following should have the least impact;

Classes (Abstract and Concrete): CamelCase
SomeClass

Functions: Mixed-case
someFunction
(it might make sense to additionally have different naming conventions for virtual functions)

Variables: lowercase-with-underscores
some_variable

Member variables: lowercase-with-underscores and ending with an underscore
some_member_variable_

Thoughts?

cliff-bohm commented

If we use this standard, will that mean that PLs will change?
i.e. does 'cullBelowPL' become 'cull_Below_PL'?

or 'cull_below_pl_'?

JorySchossau commented

I suspect acronyms remain all caps, such as member variables: cull_below_PL_