...
Interfaces should always be given first pick of clear names that convey their purpose. For example, if there is an interface representing a network device, and a class implementing it, the interface should be given the name Device
, and the class, something indicating that it implements the Device
interface, e.g. DefaultDevice
.
Class and interface names whose names are based on acronyms such as IP
, PCEP
, BGP
, etc. should continue to follow the standard camel-casing convention, e.g. IpAddress
, PcepService
, BgpMessage
. This maintains readability and avoids confusion between names of classes and names of constants. There are a few exceptions to this in ONOS code-base, mostly in legacy code; new code should adhere to the camel-casing convention, however.
Referencing
Wherever possible, references should be made to the interface, and not the implementing class. This includes method parameters.
...