垃圾代码书写准则
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

82 lines
1.5 KiB

5 years ago
# State-of-the-Art Shitcode Principles
5 years ago
[![State-of-the-art Shitcode](https://img.shields.io/static/v1?label=State-of-the-art&message=Shitcode&color=7B5804)](https://github.com/trekhleb/state-of-the-art-shitcode)
5 years ago
## Get Your Badge
5 years ago
5 years ago
If your repository follows the state-of-the-art shitcode principles you may use the "state-of-the-art shitcode" badge:
5 years ago
```
5 years ago
[![State-of-the-art Shitcode](https://img.shields.io/static/v1?label=State-of-the-art&message=Shitcode&color=7B5804)](https://github.com/trekhleb/state-of-the-art-shitcode)
5 years ago
```
5 years ago
## The Principles
5 years ago
### 💩 Name variables in a way as if your code was already obfuscated
5 years ago
5 years ago
Less keystrokes, more time for you.
5 years ago
Good 👍🏻
5 years ago
5 years ago
```javascript
5 years ago
let a = 42;
```
5 years ago
Bad 👎🏻
5 years ago
5 years ago
```javascript
5 years ago
let age = 42;
5 years ago
```
5 years ago
### 💩 Mix variable/functions naming style
Celebrate the difference.
Good 👍🏻
```javascript
let wWidth = 640;
let w_height = 480;
```
Bad 👎🏻
```javascript
let windowWidth = 640;
let windowHeight = 480;
```
### 💩 Never write comments
No one is going to write your code anyway.
Good 👍🏻
```javascript
const cdr = 700;
```
Bad 👎🏻
```javascript
// Callback function debounce rate in milliseconds.
const callbackDebounceRate = 700;
```
5 years ago
### 💩 Always write comments in your native language
5 years ago
5 years ago
_If your native language is English you may violate this rule_
5 years ago
Good 👍🏻
5 years ago
```javascript
5 years ago
// Закриваємо модальне віконечко при виникненні помилки.
toggleModal(false);
5 years ago
```
5 years ago
Bad 👎🏻
5 years ago
```javascript
5 years ago
// Hide modal window on error.
toggleModal(false);
5 years ago
```