주석을 죽입시다! 주석은 나의 적!

좍이(59.7) 2011.02.20 20:18:46

조회 165 추천 0 댓글 9

난 안티 주석자이다.

사실, 주석만큼 취향타는 부분도 없지만,

주석이 적은 코드가 좋은 코드라고 강력히 주장하는 바이다.

내가 주석에서 긍정하는 것은 딱 javadoc에 쓰이는 곳까지다.

함수 등의 스펙을 명세하는 수준.

딱 거기까지 ㅇㅇ

여기까진 정말 이상적인 주석이다.

코딩과 문서화가 어우러지는 아름다운 부분이지.

하지만 그 외에는 주석이 없어도 코드가 자신을 잘 표현할 수 있어야한다.

함수&변수명은 자기 스스로를 명확하게 표현해야한다.

중간 중간에 주석이 필요하다면,

주석이 없어도 설명이 되도록 리펙토링해야한다.

아래와 같은 주석은 독자에게 방해만 되며, 아무런 정보도 생산하지 못한다.

// johnson 1보다 크면

if( johnson > 1 )

혁신적인 알고리즘이라면 구동원리를 주석으로 문서화해서

독자의 이해를 높일 수 있을 때도 있다.

하지만 그 언어가 최소한 함수를 지원한다면,

그 구동원리는 함수스펙에 명세하는 것으로 충분하다.

1줄의 코드를 설명하기 위해서 1줄 이상의 주석으로 코드의 의도를 설명해야한다면

그 코드는 잘못된 것이다.

이런 신념 덕에 난 리펙토링 덕후이기도 하다.

짧고 간결하며, 코드만으로 모든게 설명이 될 때, 코르가즘을 느끼지.

"우리나라 같이 열악한 실무환경에서는 빨리 짜는게 최고일꺼야"라는 얼토당토한 환상을 가지는 늅늅들이 있던데,

빨리 짜는 것도 좋지만, 걸레 같은 코드 짜면 상사한테 맞는다 ^^

주석은 최소화해야한다는 나의 견해에 동의하는 사람이 얼마나 있을지는 모르겠다마는

주석이 과도해지는 순간, 아무리 좋은 코드라도 읽기 힘들어진다.

고정닉 0

전체 댓글 0개

등록순

본문 보기

타인의 권리를 침해하거나 명예를 훼손하는 댓글은 운영원칙 및 관련 법률에 제재를 받을 수 있습니다.
Shift+Enter 키를 동시에 누르면 줄바꿈이 됩니다.

갤러리 리스트
번호	제목	글쓴이	작성일	조회	추천
설문	외모와 달리 술 일절 못 마셔 가장 의외인 스타는?	운영자	24/07/01	-	-
공지	프로그래밍 갤러리 이용 안내 [71]	운영자	20.09.28	35995	62
2720296	exe파일 만들어서 레지스트리값 변경 해보신분?	프갤러(112.161)	00:57	7	0
2720295	직장생활 꿀팁 알려줄까	ㅇㅇㅇㅇ(175.208)	00:50	7	0
2720294	아씨발 네트워크 c+ 떴다,,	프갤러(14.52)	00:48	14	0
2720293	정신병자들 글좀 그만써라	ㅇㅇ(175.199)	00:47	9	0
2720292	오늘의 소설, 영화 실마리: 유명한 싱어송라이터나 작곡가에게 과외	발명도둑잡기	00:37	7	0
2720291	나님 막담✨	♥전설의포켓몬냥덩♥	00:27	12	0
2720289	씨발 진짜 백준입력 받는 거 어캐하는거냐	ㅇㅇ(118.235)	00:18	25	0
2720288	공부 많이하면 생각을 덜 하게 됨	영혼추수	00:16	19	0
2720287	파이썬 공부하는하꼬 고딩인데용 [5]	프갤러(210.179)	00:14	31	0
2720286	어린이 대공원 정문 안쪽 E마트 바가지..ㅇㅅㅇ	헤르 미온느	00:11	10	0
2720284	동아시아의 3대 미스터리 [1]	발명도둑잡기	00:07	21	0
2720283	왜 천재들은 조용한 성격인가?	영혼추수	00:01	19	0
2720282	천재일수록 조용한 곳을 선호함 [1]	영혼추수	06.30	33	0
2720281	왜 나님은 이상한 스토커들이 따라붙는걸깡.. [2]	♥전설의포켓몬냥덩♥	06.30	20	0
2720280	음기 충전	발명도둑잡기	06.30	18	0
2720279	귀여운 냥덩이 보고 힐링✨	♥전설의포켓몬냥덩♥	06.30	15	0
2720277	프갤애들도 산에서 살면 정신병 줄어들듯 [3]	영혼추수	06.30	30	0
2720276	여자아이 성학대 즐기고 싶음 ㅇㅅㅇ	류류(118.235)	06.30	10	1
2720275	엄청 잘나갔는데 미국에서 선생님하고 있다는 탑연예인 근황	발명도둑잡기	06.30	8	0
2720274	거대 언어 모델의 망할 특징 [3]	☆단비☆	06.30	38	0
2720273	아재들의 술이라고?...왜 Z세대는 와인을 안 마실까	발명도둑잡기	06.30	7	0
2720272	좌파·우파·페미니즘으로 역주행 예능을 만든 권성민 PD	발명도둑잡기	06.30	9	0
2720271	자존감이 너무 낮은데 어떡하냐 [9]	프갤러(39.117)	06.30	43	0
2720270	llama-cpp 한글도 됨.	☆단비☆	06.30	9	0
2720269	지방은 집값 얼만지 아냐? [3]	영혼추수	06.30	37	0
2720268	뻘글)) 귀여운 고양이 보고 힐링	ㅇㅇ(183.109)	06.30	16	0
2720267	13시간 돌파	프갤러(175.119)	06.30	13	0
2720266	~하다 라는 말투 오글거리지않냐?	헬마스터	06.30	19	0
2720265	llama-cpp 아싸 된다.. 개신기하네	☆단비☆	06.30	13	0
2720264	[사설] 광화문 100m 태극기, 오세훈 시장 ‘고루한 발상’ 접어야	발명도둑잡기	06.30	11	0
2720263	Visual studio 설치 좀 도와주라 [3]	호에엥(1.228)	06.30	27	0
2720262	무슨 게임을 할까 하다가 마인크래프트를 하기로 결정하셨다. [1]	ㅇㅇ(123.213)	06.30	14	0
2720261	이선균씨가 그리운 밤입니다 [3]	헬마스터	06.30	28	0
2720260	졸리댜.	브레이버	06.30	7	0
2720259	프갤은 매번 볼때마다 천재 호소인만 있는듯	프갤러(118.235)	06.30	20	0
2720258	새끼냥아.. 함께해서 고마웠어.. 그곳에선 행복하렴..	♥전설의포켓몬냥덩♥	06.30	14	0
2720257	냥덩이 키우던 고양이 [2]	발명도둑잡기	06.30	24	0
2720256	llava-cli 왜 안 되나 했더니 ㅎㅎ 모델 다운 받아야 됨 [5]	☆단비☆	06.30	25	0
2720255	새끼냥이 근황⭐+	♥전설의포켓몬냥덩♥	06.30	17	0
2720254	나님 주말 내내 공부 단 한 줄도 안 하시다 [1]	진척	06.30	24	0
2720253	지구상의 모든 금 은 구리는 외계에서 온것임 [2]	♥전설의포켓몬냥덩♥	06.30	27	0
2720252	루비가 LLM을 공부하는 걸 보고 느끼는 바가 많다	진척	06.30	16	0
2720251	강식당은 백식당보다 재미가 좀 덜하다 [2]	헬마스터	06.30	17	0
2720250	김흥국에 폭발한 해병	발명도둑잡기	06.30	13	0
2720249	시발 C++ 소켓 뭐이리 복잡함 [3]	프갤러(104.28)	06.30	47	0
2720248	나디아&톱을노려라&에반게리온 세계관 분석 총집편	♥전설의포켓몬냥덩♥	06.30	11	0
2720247	이게 나라냐	발명도둑잡기	06.30	10	0
2720245	개발자한테 일감 따오라는곳 [1]	프갤러(220.88)	06.30	31	0
2720246	의사들이 제발좀 하지 말라는것들	ㅇㅇㅇㅇ(175.208)	06.30	19	0