Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ninanoray authored Nov 6, 2023
1 parent 93acea5 commit bbbb417
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@

### 1. 명명규칙(Naming Conventions)

1. 이름으로부터 의도가 읽을 수 있게 쓴다.
- 이름으로부터 의도가 읽을 수 있게 쓴다.

```jsx
// bad
Expand All @@ -65,7 +65,7 @@
}
```

2. 오브젝트, 함수, 그리고 인스턴스에는 `camelCase`를 사용한다.
- 오브젝트, 함수, 그리고 인스턴스에는 `camelCase`를 사용한다.

```jsx
// bad
Expand All @@ -78,14 +78,14 @@
function thisIsMyFunction() {}
```

3. 함수 이름은 동사 + 명사 형태로 작성한다.
- 함수 이름은 동사 + 명사 형태로 작성한다.
`postUserInformation( )`
4. 약어 사용은 최대한 지양한다.
5. 이름에 네 단어 이상이 들어가면 팀원과 상의를 거친 후 사용한다
- 약어 사용은 최대한 지양한다.
- 이름에 네 단어 이상이 들어가면 팀원과 상의를 거친 후 사용한다

### 2. 블록(Blocks)

1. 복수행의 블록에는 중괄호({})를 사용한다.
- 복수행의 블록에는 중괄호({})를 사용한다.

```jsx
// bad
Expand All @@ -108,7 +108,7 @@
}
```

2. 복수행 블록의 `if``else` 를 이용하는 경우 는 블록 끝의 중괄호( } )와 같은 행에 위치시킨다.
- 복수행 블록의 `if``else` 를 이용하는 경우 는 블록 끝의 중괄호( } )와 같은 행에 위치시킨다.

```jsx
// bad
Expand All @@ -123,7 +123,7 @@

### 3. 코멘트(Comments)

1. 복수형의 코멘트는 `/** ... */` 를 사용한다.
- 복수형의 코멘트는 `/** ... */` 를 사용한다.

```jsx
// good
Expand All @@ -138,7 +138,7 @@
}
```

2. 단일 행의 코멘트에는 `//` 을 사용하고 코멘트를 추가하고 싶은 코드의 상부에 배치한다. 그리고 코멘트의 앞에 빈 행을 넣는다.
- 단일 행의 코멘트에는 `//` 을 사용하고 코멘트를 추가하고 싶은 코드의 상부에 배치한다. 그리고 코멘트의 앞에 빈 행을 넣는다.

```jsx
// bad
Expand All @@ -157,7 +157,7 @@

### 4. 문자열(Strings)

1. 문자열에는 싱크쿼트 `''` 를 사용한다.
- 문자열에는 싱크쿼트 `''` 를 사용한다.

```jsx
// bad
Expand All @@ -167,7 +167,7 @@
const name = 'Capt. Janeway';
```

2. 프로그램에서 문자열을 생성하는 경우는 문자열 연결이 아닌 `template strings`를 이용한다.
- 프로그램에서 문자열을 생성하는 경우는 문자열 연결이 아닌 `template strings`를 이용한다.

```jsx
// bad
Expand All @@ -182,7 +182,7 @@

### 5. 함수(Functions)

1. 화살표 함수를 사용한다.
- 화살표 함수를 사용한다.

```jsx
const arr2 = [1, 2, 3];
Expand All @@ -192,8 +192,8 @@

### 6. 조건식과 등가식(Comparison Operators & Equality)

1. `==` 이나 `!=` 보다 `===``!==` 을 사용한다.
2. 단축형을 사용한다.
- `==` 이나 `!=` 보다 `===``!==` 을 사용한다.
- 단축형을 사용한다.

```jsx
// bad
Expand All @@ -207,7 +207,7 @@
}
```

3. 비동기 함수를 사용할 때 `Promise`함수의 사용은 지양하고 `async`, `await`를 쓰도록 한다
- 비동기 함수를 사용할 때 `Promise`함수의 사용은 지양하고 `async`, `await`를 쓰도록 한다


<br/><br/>
Expand Down

0 comments on commit bbbb417

Please sign in to comment.