Code Conventions

Added by Nate Johnson, last edited by Mark Christensen on Sep 06, 2006  (view change)

Here is where you will find naming conventions. This is just a start:

  1. Only abstract classes should be named with an 'Abstract' prefix, e.g., AbstractXXX. (Hmm, what about a class representing an abstract interpreter?)
  2. All uses of class prefixes General, Basic, Simple, Default, Impl, Donkey, etc... will become: DefaultXXX
  3. Widgets that are not obviously widgets will all have the suffix "Widget" appended to their class name. For example: LinkageGraphWidget and FluencyWidget, whereas Button and Checkbox do not need Widget appended (Why not?)
  4. Actions will all have the suffix "Action" appended to their class name.
  5. Events will all have either the suffix "Event" or the suffix "Request" appended to their class name.
  6. Don't commit printlns to the repository. Fisheye sees all.
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.