realXtend / tundra

realXtend Tundra SDK, a 3D virtual world application platform.
www.realxtend.org
Apache License 2.0
84 stars 70 forks source link

Decide naming convention for symbol names containing abbreviations (XmlRpcCall [A] vs. XMLRPCCall [B]) #761

Open Stinkfist0 opened 10 years ago

Stinkfist0 commented 10 years ago

Personally I'd vote for the [A] convention: 1) When there are lots of contiguous abbreviations in a symbol name, deciphering a symbol name written using [B] requires a priori knowledge of the abbreviations, 2) personal preference ("looks clearer and better"), 3) Qt uses it (f.ex. QUdpSocket), 4) [B] can lead to all uppercase names which is not nice (f.ex. UIAPI) and can be mixed with preprocessor defines.

Preferably use the same convention for both Tundra, WebTundra. FWIW, currently I could find at least four different styles currently in the code base: A (HttpAssetProvider), B (SaveSceneXML), mixed (UiAPI), and even something else (DecompressCRNtoDDS).

jonnenauha commented 10 years ago

I think AssetApi etc would just feel wrong if we were to change it :) I like B better but have to mix it up sometimes, like SaveSceneXML looks good but DecompressCRNToDDS and DecompressCrnToDds look bad.

I would stick with upper case with possibility to override if something else looks better :P Kind of a meh topic tbh :)