[일반] 이런식으로 코드에 주석달아놓는거 안좋아보임?

[더진한초코우유(chiwoojw)]

이런거 안달아놓으면 나중에 까먹을까바 

모르는내용이나 첨써보는 로직이면 무조건 저렇게 적어두는데

팀원들이 나중에 허접이냐고 머라하면 어카지

[착해진웃스음(112.168)]

쓸데없는 주석은 달지마

[백갤러 1(14.42)]

그럼 어캐 달음?

[착해진웃스음(112.168)]

저건 진짜 의미없는 주석인데 이미 코드레벨에서 명확하게 보이는 주석을 뭐하러 달지?? - dc App

[착해진웃스음(112.168)]

레디스에 연결 실패하면 sys.exit은 너무 당연한거 아닌가? 이걸 주석을 써가면서 알려줘야 하는 내용이야?? - dc App

[더진한초코우유(chiwoojw)]

아니 알려주는게 아니라 내가 나중에 뭔지 인지하려고 쓴건대..

[착해진웃스음(112.168)]

코드를 ai한테주고 주석을 써달라하셈 - dc App

[익명(223.39)]

이게 맞다 코드 읽으면 아는 내용을 주석을 왜 적노 시간 아끼려면 ai한테 물어보면 되지

[익명(106.102)]

왜 에러를 던지는대신 sys.exit를 썻는지 주석 달면 좋을듯

[더진한초코우유(chiwoojw)]

오 고마어

[익명(106.102)]

주석은 함수의 명세 또는 코드로는 알 수 없는 맥락을 담아주면 됨 '연결 실패 시 프로그램을 종료한다' 처럼 주석달면 되고 '왜 에러 대신 프로그램을 종료하는가?' 는 코드로는 모르니까 미래의 나를 위해 달아주면 됨

[익명(175.119)]

보통 메서드 위에 적는건 해당 메서드의 역할을 뜻하는거라 sys.exit 내용은 해당 코드에 주석 하나면 써두면 댐

[백갤러 2(223.39)]

나 스프링 로직 분석할때 컨트롤러 하나하나가 좀 길어서 꽤 자명한것도 뭉통이로 묶어서 작성해두는데.. ㅎㅎ 맡는 시스템이 많으면 이렇게 안해두면 담에 다시 분석해야함. 내가 손대는 부분에 한해선 기존 컨벤션 맞춰서 Java doc도 작성해둠. 난 이렇게 하는데 머리 좋았으면 안했을거 같긴 해.

[백갤러 3(58.232)]

SI는 내가 만든걸 다른 사람이 유지보수하게 되니 이런식으로 보통 적는데, 오픈소스도 비슷한 이유로 설명 작성함. 포폴용이라면 누군가 보기 편하게 작성하는것도 나쁜건 아니라고 봄. 물론 윗댓들처럼 코드가 명확한게 전제조건