Skip to content

Refactor Stuff according to Naming Conventions #25

Description

@tomwendel

Some of the Basic Class Structure uses an messy Name Structure. This should be refactored.

  • Property Names
    The common Convention for Properties to a PropertyList Class is "[Feature][Class]Property" (e.g. Item -> WalkableItemProperty,
  • State & Info Classes
    Classes that represent the direct State or Info to another class should have the regular Class Name plus the Keyword "State" or "Info". (e.g. Item -> ItemState, ItemInfo, AntItem -> AntItemState, AntItemInfo). Same for Properties (e.g. WalkableItemProperty -> WalkableItemPropertyState, WalkableItemPropertyInfo)
  • Interop Properties
    The Properties for Interop Classes follow the same rule as the Item Properties. FactoryInterop -> FactoryInteropProperty. (e.g. Property for AntUnitInterop -> InteractUnitInteropProperty)

This leads to very long Class Names :-( Especially for the classes that are visible for the coder (Info/Property, Interop/Property) we should think about a shorter Convention. Any Ideas?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions