Assignment Search Framework
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
Code Conventions

Below is a list of the conventions used in the code. Some may be changed at a later date (enoted by TODO)

  • Header files have extension .h, while source files have extension .cpp
  • File names are all in lower case, with underscores delimiting words (ie. transition_system.h)
  • Class names are in camel case, with the first letter capitalized.
  • Member functions are in camel case, with the first letter uncapitalized.
  • Member and local variables are in lower case, with underscores delimiting words.
  • Non-member functions are in lower case, with underscores delimiting words. TODO: Is this really the best idea?
  • TODO: Should we have a source file for all files including abstract files? Two files for each?
  • TODO: Where to put the code in a templated function? Do the .cpp "include" hack? Does this work with non-class files with a mix of templated and untemplated functions?