좋은 주석을 작성하는 방법

---

1. 주석을 코딩하기 전에 작성해놓으면,

코딩을 하면서 구현이 쉬워진다.

이 코드들이 어떤식으로 어떻게 동작하는 지 먼저 설명하기

 

2. 함수에 주석을 다는 것이 가장 효율적이다.

 

3. 복잡한 소스코드보다

주석 없이도 빠르게 이해할 수 있는 코드가 좋다.

>> 개발비용보다 유지보수 비용이 훨씬 크기 때문이다.

 

4. 프로토타입은 주석 필요 없다.

 

5. 설계 리뷰가 코드 리뷰보다 훨씬 중요!

 

6.  라이브러리나 프로그램, 함수 단위에서는 '무엇'인지 설명한다.

 

7. 실행문에 달아두는 주석은 코드가 '왜' 이렇게 동작하는 지 설명한다.

 

---

문서 주석

/** */

 

구현 주석

/**/ or //

---

코드리뷰란?

한 명 또는 여러 명의 개발자들이 

본인이 만들지 않은 코드의 내용을 점검하고

피드백을 주고 받는 과정이다.

이 과정을 통해

코드에 대한 책임이 

우리 모두에게 있다는 문화를 만들어나간다.

 

 

코드리뷰가 중요한 이유?

코드 리뷰의 장점은!

1. 버그의 조기 발견이 가능하다.

2. 개발표준 준수

3. 중복 코드를 방지

4. 모듈의 재사용성 증대

 

즉,

본인이 발견하지 못한 문제점이나 실수들을

다른 사람들이 발견하여 

더 일찍 조치를 취할 수 있다.

 

또한,

잘 만들어진 코드를 보며

배울 수 있는 기회를 얻게 된다.

---

코드 리뷰시 확인해야 하는 것

 

1. 기능의 정상동작 여부

 

2. 버그 발견

 

3. 가독성과 유지보수 편의성

 

4. 개발 표준의 준수 여부

>> 최소한의 기본적인 표준을 정하고,

프로젝트를 하면서

하나씩 기준들을 추가해나가는 것이 좋다.

들여쓰기의 크기, 코드 한 줄의 최대 길이,

파일과 변수의 명명규칙 등등등

 

5. 테스트 코드의 작성여부

 

 

---

wraithkim.wordpress.com/2018/01/04/%EC%A2%8B%EC%9D%80-%EC%A3%BC%EC%84%9D%EC%9D%84-%EC%93%B0%EB%8A%94-%EA%B8%B0%EC%A4%80-%EC%84%B8-%EA%B0%80%EC%A7%80/

좋은 주석을 쓰는 기준 세 가지

blog.logi-spot.com/%EC%BD%94%EB%93%9C%EB%A6%AC%EB%B7%B0%EC%9D%98-%EC%A7%84%EC%A7%9C-%EB%AA%A9%EC%A0%81%EC%9D%80-%EB%94%B0%EB%A1%9C%EC%9E%88%EB%8B%A4/

코드리뷰의 진짜 목적은 따로있다

>>출처