Every developer should know how the naming conventions help to make the code more readable, maintainable, organized, and of higher quality.
- Code readability: Consistent naming conventions make code easier to read and understand, both for the original author and for other developers who may work on the code in the future.
- Code maintainability: Following conventions makes it easier to maintain the code, especially in larger projects, as it provides a clear and predictable structure.
- Code organization: Consistent naming helps to organize code and makes it easier to find specific classes, functions, and variables.
- Collaboration: Consistent naming conventions make it easier for multiple developers to work on the same codebase, as everyone knows what to expect from the names used.
- Code quality: Following naming conventions and best practices can also improve the overall quality of code and make it easier to debug and test.
.png)
Class names: UpperCamelCase, starting with a capital letter.
For example:
class MyClassName {
// class body
}
Function names: lowerCamelCase, starting with a lowercase letter.
For example:
void myFunctionName() {
// function body
}
File names: snake_case and should match the name of the main class defined in the file, with a .dart extension.
For example, if the main class is named MyClassName, the file should be named my_class_name.dart.
Variable names: lowerCamelCase, starting with a lowercase letter.
For example:
int myVariable;Object names: lowerCamelCase, starting with a lowercase letter.
For example:
MyClassName myObject = MyClassName();
It's worth noting that these naming conventions are guidelines, and the most important thing is to be consistent throughout your codebase.
.png)