PongUIO/AndroidWars — Issue #7: Improved naming distinction between Sim:: and ExtS:: types
Author: Thekian
Created: 2012-02-23 15:15:51+00:00
State: open
Labels: extsim

Currently data type names are not very distinct between Simulation and ExtSim. An example of this is ExtBot+BotData residing in the pair extsim/datatype/Bot.h/.cpp. While ExtBot is aptly named, ExtS::BotData has a very similar name to Sim::BotDatabase, and using Bot.h/.cpp instead of ExtBot.h/.cpp as filenames further confuses their purpose (despite their file location). This may cause confusion.

A suggested naming architecture for the ExtS:: namespace is:
- The general rule is to prefix Ext to all types that may be sufficiently confused with Simulation types.
- Prefix all extsim/datatype/ types with Ext for all database content types (like ExtBot)
- Prefix all extsim/datatype/ database types with Ext, and suffix Data (for example ExtBotData)
- Prefix all subsystems with Ext
- Update filenames so that they better reflect the main class in the file.
- Types that are unique do not need an Ext prefix (such as RuleParameter)

See: extsim/* and comparable files in simulation/*