vscode 에 들어갔다가 나오는거 테스트

출처

스타일 GUIDE 링크 (https://cs50.readthedocs.io/style/c)

---

유형별 style guide 요약

style guide 의 필요성

• reliably analyze your code’s style

Line length

• a line of code is ==80 characters== long in C

  • 왜냐면, old computer 가 '24 lines vertically and 80 characters horizontally' 를 담을 수 있었기 때문.

• javascript 에서의 제언

  • 자바 스크립트는 특성상 굉장히 코드가 길어짐
  • your goal should instead be to ==break up lines (as via \n)== in locations that maximize ==readability and clarity==.
    • 즉, 'break up line' 을 해서 -> 가독성을 높여라

---

comments

• comments 필요성

   - code 을 더 ==readable== 하게 만든다. 
   - ==readablity== 하면 -> 1) 다른 팀원 2) 자기 자신에게 도움 
       - ex) 몇 시간, 몇 주, 몇 달이 지나서 해당 코드를 =='유지보수'== 할 때 도움이 된다. 
       - 왜냐면, '이게 어떤 맥락에서 한 말인지 모를때가 있으니까.'

• 그러면, 어떻게 comment?

    - too much, too little 이 아닌, ==sweet spot== 에 해야 함 -> 그러면 sweet spot 은? 

• sweet spot 은? ⭐⭐⭐

   1. ==What does this block do?
   2. ==Why did I implement this block in this way?

• sweet spot 에 어떻게 작성하면 좋아?

1. comment 는 ==code 윗 줄==
2. No need to write in full sentences, but do capitalize
3. comment 사이에는 ==space 한 칸== 남기기

Do

Don't do this

4. file 에는 어떤 프로램인지 설명하는 부분이 있어야 함

   .c and .h files should be a comment that summarize what your program (or that particular file) does, as in:
   

5. 각 ==function== 에는 what your function is doing 에 대한 설명이 있어야 함.

   • 이때, ==keyword== 를 사용할 것 ⭐⭐

     // Returns the square of n
     int square(int n)
     {
     return n * n;
     }

---

Conditions (조건문)

• 가독성을 위해 참고할 style guide

  • 대괄호 { }

    • 위 아래 줄을 잘 맞출 것 (line up nicely)
    • ==branch== 안에 어떤 내용물이 있는지 보이게 할 것

  • if

    • if 다음엔 ==single space== 를 둘 것

  • branch 안의 내용물을 쓸 때는 ==4 spaces==

    • 보통 tab 한 번 이면 되는 듯.

  • < 또는 >

    • 꺽쇠 앞뒤엔 ==single space== 를 둘 것

  • ( 또는 )

    • 괄호 앞 뒤에 ==no space (isn't any space)== 를 둘 것

• 좋은 예시 (DO)

  if (x > 0)
  {
    printf("x is positive\n");
  }
  else if (x < 0)
  {
    printf("x is negative\n");
  }
  else
  {
    printf("x is zero\n");
  }
  

- `Don't do this`
    -  { } 를 한줄에 쓰는 경우 (예시1)
```js
if (x < 0) {
    printf("x is negative\n");
} else if (x < 0) {
    printf("x is negative\n");
}

- 예시 2

if (x < 0)
    {
    printf("x is negative\n");
    }
else
    {
    printf("x is negative\n");
    }

---

indentation (들여쓰기)

• 필요성

  • 어떤 코드 블록이 다른 코드 블록 '내부' 에 있는지를 명확히 하게 하기 위한 것

    make clear which blocks of code are inside of others

• 주의할 점

  • editor 마다 \t 를 렌더링 하는 방식이 다름
  • \t 를 four spaces 로 하는 것이 일반적.
  • 그렇게 하지 않는 에디터도 있음을 유의

• 좋은 예시 ⭐⭐⭐⭐⭐

  • comment + 함수 + for 문 이 같이 나오면 이렇게 작성해보자 ⭐⭐⭐

    // Print command-line arguments one per line
    printf("\n");
    for (int i = 0; i < argc; i++)
    {
    for (int j = 0, n = strlen(argv[i]); j < n; j++)
    {
      printf("%c\n", argv[i][j]);
    }
    printf("\n");
    }
    

▫ 



--- 

### Loops (반복문)


#### **1) for** 

- 일반 원칙 1️⃣ 
iteration 에 필요한 ==temporary variable== 에는  `i`, `j`, `k` 를 사용. 만약, `more specific names` 이 readable 에 도움이 된다면, 가능. 
>     Whenever you need temporary variables for iteration, use i, then j, then k, unless more specific names would make your code more readable:

- 일반 원칙 2️⃣ 
==temporary variable== 이 ==3개 이상==이면, 코드 ==design 을 다시== 생각할 것 
> If you need more than three variables for iteration, it might be time to rethink your design!


- 느낀점 
    - 반복문에 temporary variable 은 반드시 필요한 요소 구나! ⭐⭐⭐ (이게 신기하긴 함. 뭔가 숨어있는 요소 처럼 느껴지기도 하고) 



#### 2) while 

- **style guide**
    - 대괄호 `{ }`
        - 위 아래 줄을 잘 맞출 것 (line up nicely)
        - ==branch== 안에 어떤 내용물이 있는지 보이게 할 것 

    - `while`
        - if 다음엔 ==single space== 를 둘 것

    - branch 안의 내용물(==loop body==)을 쓸 때는 ==4 spaces==
        - 보통 `tab` 한 번 이면 되는 듯. 

    - `(` 또는 `)`
        - 괄호 앞 뒤에 ==no space (isn't any space)== 를 둘 것 

- 예시 
```python
while (condition)
{
    // Do something
}

---

Variables (변수)

• loop 의 iteration 에 필요한 ==temporary variable== 의 경우 i, k, j 를 보통 사용
• 다른 대부분의 변수는 more specifically named, descriptive 해야 함.
  • ex) 메모리에 담긴 값은 특정 데이터를 표현하고 있다고 가정하자. -> 변수명은 해당 값이 무엇을 표현하고 있는지를 잘 담고 있어야 함 ⭐⭐⭐⭐⭐
• 2개의 단어가 필요하면, undersocre 를 사용
  • ex) is_ready