Pixie16 Analysis Software Suite
Analysis code for processing of .ldf files
Naming Conventions

Some sort of convention – maybe not the best, but at least it's a choice. Of course, these are solely a suggestion, and exceptions could occur.

  • Classes are things: "ExampleClass"
  • Variables and class members have names like "myVariable"
  • Namespaces like "thisNamespace"
  • Acronyms uncapitalized generally like "DssdProcessor" (exceptions may abound)
  • Global CONSTANT variables can have forms like "CONSTANT_VARIABLE"
  • C++ functions declared as actions: "DoSomething(...)"
  • Fortran functions called as "func_()"
  • Implementation of classes in files with the same name as the class
  • Files with extensions ".cpp", ".hpp", and ".f"
  • Generic index variables use "i,j,k" or more explicit names such as "mod, ch"; if you need more, consider reorganizing your code
  • Enumeration types like "EColors" with members "BLUE, RED, ORANGE"
  • Typedefs with simple names like "word_t"
  • Spectrum IDs use namespaces as appropriate and constant names like "D_ENERGY" (1D) or "DD_ENERGY__TIME" (2D, time (y) vs. energy (x)): subject to further consideration