https://cnr.sh/essays/how-paint-bike-shed-kafka-topic-naming-conventions helped us answering that same question. As a summary this article suggest to follow similar best practices to naming databases and tables, and it provides these additional points of advice: Avoid topic names based on things that change Avoid topic names based on information that would be stored in other places Avoid topic names … Read more
Just use Pascal naming convention. Dont attribute the key to a module or the class. Generalize it so that it can be reused. Eg: ReadWriteWarningMessage The dot separated convention works fine for menu items. But what about strings that are generated dynamically or user messages.
These are often used interchangeably. If you’re being careful about language, these have specific (engineering) meanings (courtesy of Wikipedia): In engineering, a corner case (or pathological case) involves a problem or situation that occurs only outside of normal operating parameters—specifically one that manifests itself when multiple environmental variables or conditions are simultaneously at extreme levels, … Read more
Microsoft has an excellent set of guidelines on class library design, including a section on naming. In short (examples in parentheses): Classes/Structs: PascalCase (WebRequest) Interfaces: PascalCase with I prefix (IDisposable) Methods: PascalCase (ToUpper) Properties: PascalCase (Length) Events: PascalCase (Click) Namespaces: PascalCase (System.Collections; unusual to have two words in one part though) Non-constant variables including parameters: … Read more
From the Java Language Specification on identifiers: The $ character should be used only in mechanically generated source code or, rarely, to access pre-existing names on legacy systems.
Its the complete opposite, the naming convention clearly identifies an interface. For example if you have: public class Dog : IPet, IMammal { …. Just from reading it, I can safely assume that IPet and IMammal are probably interfaces. The .NET CLR allows for single class inheritance. So, if I have a base class..I can … Read more
In earlier days with maven I followed the following structure which you have described: appname +— appname-module1 +— appname-module2 +— appname-module2-chhild1 +— appname-module2-chhild2 +— appname-module3 But this will become ridiculous if you get more levels. So I decided to change my mind and now using things like: appname +— module1 +— module2 +— chhild1 +— … Read more
C/C++ uses the famous make-stuff-up-as-we-go-along naming convention. In general, the only consistent things you can say about the C/C++ standard library naming convention is that it doesn’t use camel case (except for C++ STL template typenames), it uses lower-case class and function names, and (sometimes) uses underscores to separate words. But the usage of underscores … Read more
Yes, uppercase-initial classes are the convention, as outlined in PEP 8. You are correct that many builtin types do not follow this convention. These are holdovers from earlier stages of Python when there was a much bigger difference between user-defined classes and builtin types. However, it still seems that builtin or extension types written in … Read more