/*

나도모름

*/

코드만 존재하면, 코드로 로직 분석이 가능하지만

주석과 코드 내용이 다를수 있는 경우에 대해서는 어떻게 생각하나용

// 이건 모르겠지?

// 이것도 알아볼 수 있을까?

주석관리가 줜나 안됨. 한놈이라도 관리 줫같이 한거 일하는 사람 전부 발견 못하면 그 모든 주석이 의미없어지는거임

괜히 주석으로 주저리주저리 달지말라는 말이 나오는게 아니라 생각함

관리안됐을 때 리스크가 너무 큼

기억에 남는 어질어질했던 주석

//그 코드

//A에서는 B를 C로 변환함

//A는 B응답에 따른 결과를 치환함

//A클래스는 B응답값 및 C의 응답값을 관리하기 위함

//A에 따른 B이면 C에서 ~용도로 사용함

이 정도의 주석을 달아야만 보인다면 그 프로그래밍 언어가 문제가 아닐까 싶다

십중팔구 자바로 보임

후배 하나가

// 20xx.x.x OOO작성코드

이렇게 적어놔서 야 이거 뭐한거야? 했더니

자기가 그런 주석도 달았었냐며 되묻는데 개패고싶었음

너 말대로라면 코드 내 주석에 쓰지말고 코드 구조 잘 잡고 docstring같은걸 잘 작성하는게 맞는거 같은데...

근데 그게 안되면 너가 얘기한 주석이라도 잘 다는게 중요하긴 함

99%의 정확한 주석 사이에 1%의 코드와 다른 주석이 껴있으면.. 진짜 쌍욕나오더라

fn_sum(n,m); //n과 m의 곱을 구합니다.

///<summary>

///

///</summary>

// 23.11.20 수정자 김개붕 - 수정범위 안일랴줌

클린코드가 사람 많이 망친듯 ㅋㅋ

주석 볼때마다 과거의 나에게 아주 고마움을 느낌 ㅋㅋ

지금 회사에서 존나 느낌.. 존나 아름답게 짜면 모를까

주석은 의도가 불명한 코드에 대해서만 남기면 적절하다

// This code WHY?

서비스 로직 복잡하거나, 컴포넌트나 모듈들 조합된 상황이면 docstring으로 이유와 목적, 출력값 형태나 범위만 적어두면 좋음

가끔 라이브러리 버그거나, 사람의 표현과 코드 표현이 이질적이거나 직관적이지 않을때 한두줄 주석

가장 많이 하는 착각이

주석을 다는 것이 잘못된게 아닌데

주석 없이 코드를 이해할 수 없으면 잘못된 코드라고 생각하긴 하는데

하다보면 긴 코드들은 간단한 개요 등은 적으면 좋다고 생각 (가독성을 위한 주석)

그리고 개인적으로 가장 주석이 필요한 부분은 '왜'인데,

주석 없이 코드만 보았을 때 왜 이렇게 하는지는 이해하기 어려운 부분들이 있어서

(사업상 이유라던가 특정 케이스를 위해서라던가)

미래의 본인이나 미래의 후임자들을 위해서라도 "왜?" 에 대한 부분은 주석으로 많이 남기면 남길수록 좋다고 생각함.

//뭔진 모르겠는데 없으면 광원효과 사라짐

어차피 코드를 읽어야하면 주석을 달 필요가 없고

코드를 안읽어도 그 코드의 함수가 멱등성이 잘 지켜진다면 코드를 찾아 들어갈 일도 없고

함수나 클래스 네이밍을 잘 해서 의도만 파악할 수 있다면 주석을 달 필요가 없고

그래도 jsdoc이나 javadoc 같은걸 위한 주석은 다는게 좋고

우린 주석안달고 테스트코드 달고 코드만 봐도 문맥이 이해되야됨