Improve naming conventions in a future major release #2443
Labels
Category: Doc
Requests, Issues and Changes targeting javadoc and module documentation
Status: Needs Investigation
Requires to be debugged or checked for feasibility, etc.
Topic: Architecture
Requests, Issues and Changes related to software architecture, programming patterns, etc.
I think we should formalize naming for a few major class types. At present we have some inconsistencies like
BeforeDeactivateComponent
which is actually anEvent
and should probably be namedBeforeDeactivateComponentEvent
We could probably write Checkstyle rules to help enforce this. The types I have in mind:
System
Component
Event
System
naming or does that just complicate things?If there are no objections I think we should move ahead with marking style violations then
@deprecate
poorly named classes as we come across them, much like fixing style violations in general (if you're working in an area keep an eye out). Offer a better named replacement class, potentially with a new handler method somewhere with the old one just calling the new one, and let modules migrate to the new naming over time. Then delete the outdated version come next major release. Unless the deprecation was too recent.Candidates:
BeforeDeactivateComponent
toBeforeDeactivateComponentEvent
- widely used across modulesOnActivatedComponent
toOnActivatedComponentEvent
The text was updated successfully, but these errors were encountered: