Scribd
Upload
57 views1 page

Naming - Best Practices

This document outlines 15 best practices for naming variables and methods. The practices include using descriptive yet concise names, following standard naming conventions for the programming language, avoiding reused or ambiguous names, and using consistent capitalization. Variable names should describe the content and be 1-4 words typically, while method names should start with verbs and describe the action. Overall the guidelines promote clear, consistent naming to improve code readability, documentation and maintenance.

Uploaded by

Marius
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
57 views1 page

Naming - Best Practices

This document outlines 15 best practices for naming variables and methods. The practices include using descriptive yet concise names, following standard naming conventions for the programming language, avoiding reused or ambiguous names, and using consistent capitalization. Variable names should describe the content and be 1-4 words typically, while method names should start with verbs and describe the action. Overall the guidelines promote clear, consistent naming to improve code readability, documentation and maintenance.

Uploaded by

Marius
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1

15 Best Practices of Variable & Method Naming

1. Use short enough and long enough variable names in each scope of code. Generally length may be 1 char for loop counters, 1 word for condition/loop
variables, 1-2 words for methods, 2-3 words for classes, 3-4 words for globals.
2. Use specific names for variables, for example "value", "equals", "data", ... are not valid names for any case.
3. Use meaningful names for variables. Variable name must define the exact explanation of its content.
4. Don't start variables with o_, obj_, m_ etc. A variable does not need tags stating that it is a variable.
5. Obey company naming standards and write variable names consistently in application: e.g. txtUserName, lblUserName, cmbSchoolType, ... Otherwise
readability will reduce and find/replace tools will be unusable.
6. Obey programming language standards and don't use lowercase/uppercase characters inconsistently: e.g. userName, UserName, USER_NAME, m_userName,
username, ...
o For example for Java,
▪ use Camel Case (aka Upper Camel Case) for classes: VelocityResponseWriter
▪ use Lower Case for packages: com.company.project.ui
▪ use Mixed Case (aka Lower Camel Case) for variables: studentName
▪ use Upper Case for constants : MAX_PARAMETER_COUNT = 100
▪ use Camel Case for enum class names and Upper Case for enum values.
▪ don't use '_' anywhere except constants and enum values (which are constants).
7. Don't reuse same variable name in the same class in different contexts: e.g. in method, constructor, class. So you can provide more simplicity for
understandability and maintainability.
8. Don't use same variable for different purposes in a method, conditional etc. Create a new and different named variable instead. This is also important for
maintainability and readability.
9. Don't use non-ASCII chars in variable names. Those may run on your platform but may not on others.
10. Don't use too long variable names (e.g. 50 chars). Long names will bring ugly and hard-to-read code, also may not run on some compilers because of character
limit.
11. Decide and use one natural language for naming, e.g. using mixed English and German names will be inconsistent and unreadable.
12. Use meaningful names for methods. The name must specify the exact action of the method and for most cases must start with a verb. (e.g.
createPasswordHash)
13. Obey company naming standards and write method names consistently in application: e.g. getTxtUserName(), getLblUserName(), isStudentApproved(), ...
Otherwise readability will reduce and find/replace tools will be unusable.
14. Obey programming language standards and don't use lowercase/uppercase characters inconsistently: e.g. getUserName, GetUserName, getusername, ...
o For example for Java,
▪ use Mixed Case for method names: getStudentSchoolType
▪ use Mixed Case for method parameters: setSchoolName(String schoolName)
15. Use meaningful names for method parameters, so it can documentate itself in case of no documentation.

You might also like