holm/naming-cheatsheet
1
0
Fork 0
forked from extern/naming-cheatsheet
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adds "English language" section

Browse Source
This commit is contained in:
Artem Zakharchenko
2021-01-17 13:29:00 +01:00
parent eb900bba3b
commit 820d0aff0c
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -6,6 +6,7 @@
# Naming cheatsheet # Naming cheatsheet
- [English language](#english-language)
- [Naming convention](#naming-convention) - [Naming convention](#naming-convention)
- [S-I-D](#s-i-d) - [S-I-D](#s-i-d)
- [Avoid contractions](#avoid-contractions) - [Avoid contractions](#avoid-contractions)
@ -24,6 +25,22 @@ Naming things is hard. This sheet attempts to make it easier.
Although these suggestions can be applied to any programming language, I will use JavaScript to illustrate them in practice. Although these suggestions can be applied to any programming language, I will use JavaScript to illustrate them in practice.
## English language
Use English language when naming your variables and functions.
```js
/* Bad */
const primerNombre = 'Gustavo'
const amigos = ['Kate', 'John']
/* Good */
const firstName = 'Gustavo'
const friends = ['Kate', 'John']
```
> Like it or not, English is the dominant language in programming: the syntax of all programming languages is written in English, as well as countless documentations and educational materials. By writing your code in English you dramatically increase its cohesiveness.
## Naming convention ## Naming convention
Pick **one** naming convention and follow it. It may be `camelCase`, or `snake_case`, or anyhow else, it does not matter. What matters is for it to remain consistent. Pick **one** naming convention and follow it. It may be `camelCase`, or `snake_case`, or anyhow else, it does not matter. What matters is for it to remain consistent.