extern/naming-cheatsheet
1
0
Fork 1
mirror of https://github.com/kettanaito/naming-cheatsheet.git synced 2025-08-09 06:45:00 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Artem Zakharchenko
2017-06-30 10:26:05 +02:00
committed by GitHub
parent faee12137f
commit 9f545b757f
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -2,15 +2,15 @@
Naming things is hard. Is it? Naming things is hard. Is it?
## Guidelines ## Guidelines
* All namings should follow **one** agreed convention. Whether it is `likeThis`, or `like_this`, or anyhow else, it does not matter. Pick one and follow it. * Pick **one** naming convention and follow it. Whether it is `likeThis`, or `like_this`, or anyhow else, it does not matter. What matters is consistency in your work.
* Name, whether of a variable, method, or something else, should be *short*, *descriptive* and *intuitive* * Name, whether of a variable, method, or something else, should be *short*, *descriptive* and *intuitive*:
* **Short**. Variable should not take long to type, and therefore to remember, * **Short**. Variable should not take long to type, and therefore to remember,
* **Descriptive**. Name of the variable should reflect what this variable possesses/does in the most efficient way, * **Descriptive**. Name of the variable should reflect what this variable possesses/does in the most efficient way,
* **Intuitive**. Name of the variable should read naturally, as close to common speach as possible * **Intuitive**. Name of the variable should read naturally, as close to common speach as possible
```js ```js
/* Bad namings */ /* Bad namings */
const a = 5; // "a" could mean anything const a = 5; // "a" could mean anything
const isPaginatable = (a > 10); // "Paginatable" sounds extremily unnatural const isPaginatable = (a > 10); // "Paginatable" sounds extremely unnatural
/* Good namings */ /* Good namings */
const postsCount = 5; const postsCount = 5;