Update src/roadmaps/software-design-architecture/content/100-clean-code-principles/111-use-meaningful-names.md

content/software-design-and-architecture
Kamran Ahmed 2 years ago committed by GitHub
parent 33d62a96da
commit 7217359af1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 15
      src/roadmaps/software-design-architecture/content/100-clean-code-principles/111-use-meaningful-names.md

@ -1,17 +1,16 @@
# Use Meaningful Names
Using meaningful names in system architecture is important for making the code clear, readable, and easy to understand. Meaningful names can help to convey the intent and function of variables, functions, classes, and other elements of the code.
Using meaningful names is important for making the code clear, readable, and easy to understand. Meaningful names can help to convey the intent and function of variables, functions, classes, and other elements of the code.
Here are some ways to use meaningful names in system architecture:
1. Use descriptive and meaningful names for variables, functions, classes, and other elements of the code.
2. Use consistent naming conventions throughout the codebase, such as camelCase for variables and PascalCase for functions and classes.
3. Use abbreviations and acronyms sparingly and only if they are widely understood.
4. Use meaningful prefixes or suffixes to indicate the type or purpose of a variable or function, such as "is" or "get" for boolean variables or "list" for array variables
5. Avoid using single letter variable names or generic names, such as "temp" or "x" that do not convey any meaning.
6. Avoid using overly long or complex names that make the code harder to read.
- Use descriptive and meaningful names for variables, functions, classes, and other elements of the code.
- Use consistent naming conventions throughout the codebase, such as camelCase for variables and PascalCase for functions and classes.
- Use abbreviations and acronyms sparingly and only if they are widely understood.
- Use meaningful prefixes or suffixes to indicate the type or purpose of a variable or function, such as "is" or "get" for boolean variables or "list" for array variables
- Avoid using single letter variable names or generic names, such as "temp" or "x" that do not convey any meaning.
- Avoid using overly long or complex names that make the code harder to read.
By following these best practices, the system architecture will be more maintainable, testable, and less error-prone, and it will be easier to read and understand the code.
Learn more from the following links:

Loading…
Cancel
Save