주석 육하원칙

프로그래밍 갤러리

1/3

AI 성인물 소지 시청만해도 징역형.. 법사위 통과.. 부갤러
음주운전에 휘말려 '쾅'...혈중알코올농도 보니 마스널
훌쩍훌쩍 9살에 유괴되고 중학생이 되어 돌아온 딸.jpg 최강한화이글스
최강록 고기 억빠 날조에 재반박해봄 흑갤러
싱글벙글 중동에서 하면 안되는 행동ㅋㅋ ㅇㅇ
카우보이 목장에 직접 그림 그린 깃발 선물하는 기안84 감돌
24.09.25 스테이트 오브 플레이 정리 ㅇㅇ
싱글벙글 빈유여친.manhwa ㅇㅇ
아이폰16 핑크 색빠짐 불량.jpg 맛갤러
[단독]공기관 성폭력-성희롱 1317건, 여가부 현장점검 15건뿐 고맙슘봐
"워라밸·구인난 모두 잡았다"…제조업 첫 '주4일제' 공장 가보니… 야갤러
인종차별 당한 홍진경이 차별 경험 만렙 박준형을 불러서 대처법을 배움 긷갤러
시부모님의 행동(남편이랑 같이 볼꺼임).blind 띤갤러
젊은 버스기사가 받은 민원 SkyM
흑백 요리사 승리의 아이콘 ㅇㅇ

해리스 선거 사무실에 총격 발생.. 현장 사진 공개 https://naver.me/5HkpilCZ (속보) 해리스 부통령 선거 사무실에 총격 발생…현장 사진 공개[포착]미국 민주당 대선 후보인 카멀라 해리스 부통령의 선거 사무실에 총격이 가해져 당국이 조사에 나섰다. 악시오스 등 현지 매체의 24일(이하 현지시간) 보도에 따르면, 이날 애리조나주 템피에 있는 해리스 부통령 선거사무naver.me- 네이트 실버: 해리스 다시 상승선밸트고 뭐고 미시간+펜실베이니아로 올라가는 중 작성자 : 한브라

세브(211.117) 2010.12.03 16:47:58

조회 176 추천 0 댓글 5

국어 시간에 육하원칙이라는 걸 배웠지요.

언제, 어디서, 누가, 무엇을, 어떻게, 왜

이 중 “어떻게”는 소스 코드가 이미 잘 표현하고 있으니까 굳이 주석으로 달 필요는 없다고 생각해요.

“무엇을”에 대해서는 좀 논란 거리가 있는데 프로그래머가 변수, 함수, 클래스 이름을 잘 지어준다면

소스 코드가 “무엇을”을 잘 표현한다고 볼 수도 있을 것 같아요.

“어디서”라는 정보는 과연 유용한 정보인지 모르겠어요.

프로그램을 “어디서” 만들었다는 정보가 프로그램을 이해하는 데 도움이 되는 경우가 있을까요?

그럼 남은 정보는 언제, 누가, 왜 셋인데

소스 코드에 주석을 달 필요가 있을 때는 주석이 저 세 가지 정보(언제, 누가, 왜)를 담도록 하고

필요에 따라 나머지 세 정보(무엇을, 어떻게, 어디서)를 담으면 되겠죠?

※ 언제, 누가, 왜 중에서는 단연 “왜”가 가장 중요하고 그 다음이 “누가”라고 생각해요!

고정닉 0

원본 첨부파일 1

Piet_hello_big.png

전체 댓글 0개

등록순

본문 보기

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

갤러리 리스트
번호	제목	글쓴이	작성일	조회	추천
설문	논란보다 더 욕 많이 먹어서 억울할 것 같은 스타는?	운영자	24/09/23	-	-
267516	야 html5 표준이 2014년에 나오는데 지금 배워서 모해 ㅋㅋㅋ [1]	초식남(219.251)	11.08.28	116	0
267515	학부 MIT 어찌어찌 합격되도 [4]	ㅁㄴㅇㄹ(130.126)	11.08.28	109	0
267514	잡스뉴스보면 한국 왜이러나 싶더만 -_-	YesMan	11.08.28	58	0
267513	저 html5를 배우려고 하는데요.. [6]	별벼리(118.217)	11.08.28	108	0
267511	진주로 출발합니다!! 필!!승!! [7]	돌고래스피커	11.08.28	71	0
267510	대학교는 미국에서 대학원은 미국에서 [5]	ㅇㅇ(61.77)	11.08.28	134	0
267509	힘들구나	三didas	11.08.28	35	0
267507	야! 관심을 내놓으라고! 방방밥아방 [3]	y녀6디리(218.146)	11.08.28	41	0
267506	대학원은 사치다..가지마라. [2]	초식남(219.251)	11.08.28	199	0
267505	형들 닉은 뭔가 심심해 [2]	y녀6디리(218.146)	11.08.28	45	0
267504	효연처럼 그 정도 뜯어고쳤으면 [1]	우ㅈ	11.08.28	89	0
267500	UIUC 좆같음 [4]	ㅁㄴㅇㄹ(130.126)	11.08.28	62	0
267497	스키마가 뭐야?? [2]	ㅇㅇㅇ(218.155)	11.08.28	63	0
267496	프갤러 횽들 ㅠ HTML 파싱하는거 만들고있어요 도와주세요	ㄴㅁㅇㄻㅇㄴ(121.183)	11.08.28	66	0
267495	안드로이드 파워질문 [1]	개룡(110.15)	11.08.28	40	0
267494	망함그냥 쓰던앤데 [3]	지금,여기	11.08.28	70	0
267492	하.........미칠것같다... [5]	scanf(121.143)	11.08.28	116	0
267490	STL 컨테이너에서 템플릿을 사용하는 이유가 [5]	궁금이(121.129)	11.08.28	103	0
267489	사람 형아 [1]	좋은아버지	11.08.28	44	0
267488	아 아버지형 진짜 미안한데 이거마지막으루 함봐죠 ㅠㅠ [11]	사람(58.234)	11.08.28	90	0
267487	아버지형 잠시만용 [3]	사람(58.234)	11.08.28	48	0
267486	크롬북 신청할라는데	망함그냥	11.08.28	47	0
267485	형들은 안자? [7]	좋은아버지	11.08.28	78	0
267484	좋은아버지형 소환염..ㅠ [6]	사람(58.234)	11.08.28	81	0
267482	mysql 클라이언트 구하기가 왜이렇게 힘드냐. 아오 빡쳐. [7]	112121(121.129)	11.08.28	120	0
267481	난 자야겐네	y녀6디리(218.146)	11.08.28	22	0
267480	아 와우하면서 글쓰다가 [4]	좋은아버지	11.08.28	79	0
267478	얼굴없는 춤 // 2011. 8. 28	CCCC(121.172)	11.08.28	83	0
267477	이런 사진 보고 있으면 그냥 즐겁네.. ㅎㅎ.jpg [2]	blackd	11.08.28	131	0
267476	죽은 송장 형 있어?? [2]	좋은아버지	11.08.28	40	0
267475	좋은아버지형 소환됩니까? [4]	사람(58.234)	11.08.28	54	0
267474	아기갤이고 프갤이고 프로그래밍 제일 잘하는 갤은 [1]	ㄹ(61.102)	11.08.28	99	0
267473	아기갤에 가서 [3]	좋은아버지	11.08.28	45	0
267472	마지막 피방알바가 삼십분남앗다 [2]	서전트페퍼	11.08.28	52	0
267471	아기갤에 글쓰는걸 목표로 하쟈... [5]	blackd	11.08.28	126	0
267469	형들 나 직업 바꿀까? 진심 고민된다. [4]	좋은아버지	11.08.28	74	0
267468	아기갤 쩌네.. 앞으로 프로그램 짜다 짜증나면 여기 가봐야 겠다.. [6]	blackd	11.08.28	140	0
267465	그런데 프갤만 원래 훈훈한거야? [6]	좋은아버지	11.08.28	66	0
267464	으흐 내 대답이 빛을 발하고있다 [11]	Agangs	11.08.28	80	0
267461	살춤아 대학원 궁금하냐? [9]	blackd	11.08.28	185	0
267460	아하하하하하핳 TCP/IP 시-발	y녀6디리(218.146)	11.08.28	68	0
267459	ㅋㅋㅋㅋㅋ이럴때뭐라대답하지 [6]	Agangs	11.08.28	65	0
267455	으으 지금 생각해보면 내가 대학원까지 가게될줄은 상상도 못했다 [22]	System32	11.08.28	233	0
267454	성님들 php 질문 좀..도와주세요 (조공有) [21]	재경2	11.08.28	212	0
267452	쿄스케 형은 봅니다.2 [2]	좋은아버지	11.08.28	48	0
267447	정화짤은 이거지 [4]	System32	11.08.28	99	0
267446	횽들은 이럴때어떻게해? [5]	Agangs	11.08.28	67	0
267443	난 왜 정전 되면 글을 자꾸 싸지르고 싶어질까? [6]	blackd	11.08.28	60	0
267439	나 낼 꼬꼬면 사먹어볼려고 하는데.. 정말 맛있냐? [7]	blackd	11.08.28	87	0
267438	형 나 후불 교통카드 쓸려고 하는데 [8]	좋은아버지	11.08.28	64	0