문서 작성은 중요하다.

아놔콘다

2012.04.10 20:22:09

조회 58 추천 0 댓글 1

http://www.andy.pe.kr/wordpress/?p=197

문서 작성의 본질은 "맥락을 짚어주는 것"이 아닐까 싶음.

남도 이미 알고 있을만한 내용을 중언부언 끄적이는 것도 병신 짓이고, 남이 모르는 내용을 짚지 않고 혼자 씨부리는 것 역시 개념 없는 거임.

예전에 어떤 사람이 코드에 주석을 하나도 안달아놓고, 코드를 보면 다 이해가 된다고 씨부리는데...

정작 자기 자신도 다른 회사 팀들이 짜놓은 코드를 보다가 더이상 이해하기가 힘들었던지 갈아엎고 새로 짜는걸 본 적이 있음..

그 코드 역시 주석이 없어서 처음 보는 사람들은 클래스와 메소드가 어떤 상황에서 쓰이는지 하나도 나와있지 않음.

그렇다고 사용 예제가 될만한 테스트 코드도 없었음...

api 문서를 만들지 않을거면 코드 안에 간략하게 주석이라도 달아놓아야 하는데, 심지어 제법 큰 회사에서도 그렇게 안하는 새끼들이 조올라 많다는거....

지가 그 회사에 평생 있을건가? 다른 사람 엿먹이는거임....

아주 그냥 다 개새끼들임..

문서는 클래스와 클래스, 메소드와 메소드간의 맥락만 짚어주면 됨.

자바 api 문서가 처음에 보기 힘든 이유는 맥락은 잘라낸채 앵무새처럼 이 클래스는 무슨 일을 하고~~ 저 메소드는 뭘 하고~~ 이렇게 단속적으로 끄적여놓았기 때문임... 아, 근데 그거 가지고 뭐 어떻게 하라고?

Jaxp 같은거 한 번 보셈.

존나 끄적여 놓기만 했지, 그거 보고 파서 팩토리 인스턴스 얻어내고 핸들러 구현해서 정보 뽑아낼 새끼가 몇이나 되겠음? 뭔가를 하려고 할 때 jaxp api 는 별 도움이 안된다는걸 알 수 있음. 별도의 설명 문서를 보고나서 클래스들이 어떤 식으로 사용되는지 알고나서야 api가 의미있어짐..

질문할때도 아무 생각 없이 막 씨부리는 새끼들 의외로 많은데, 지가 해결하고 싶은 문제가 있으면 "남이 알아야할 정보"가 뭘까 고민부터 해야하는데, 대개의 질문글들을 보면 "나 급하다"는 것 밖에 없는 경우가 많음.

아~ 이새끼가 급하구나~ 딱 이거 하나만 알 수 있음.

저런 새끼들이 나중에 개발한다고 설치면 여러사람 피곤하게 하는 거임.

아무튼 정리하면 문서는 중요하다! 이거지!!

고정닉 0

원본 첨부파일 1

문서작성_중요하다.jpg

전체 댓글 0개

등록순 최신순 답글순

본문 보기

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

갤러리 리스트
번호	제목	글쓴이	작성일	조회	추천
설문	뛰어난 운동 신경으로 남자와 싸워도 이길 것 같은 여자 스타는?	운영자	25/11/24	-	-
AD	따뜻한 겨울나기! 방한용품 SALE	운영자	25/11/27	-	-
310040	횽들 이거 재밌을거 같지않음? [1]	생물학(211.234)	12.04.11	40	0
310039	계속 글올려서 미안한데... [18]	하루애(183.108)	12.04.11	88	0
310038	이거 멋있지 [1]	김멋져	12.04.11	42	0
310037	이럴줄알았으면 고정닉좀 신중하게 팔걸 [3]	김멋져	12.04.11	67	0
310035	프갤 새 주제 [2]	생물학(211.234)	12.04.11	38	0
310034	남자가 짤을 판다면 그림짤 정도는 되야지. [1]	생물학(211.234)	12.04.11	57	0
310033	난 짤 바꾸고 싶은듸 [10]	땡칠도사	12.04.11	105	0
310031	그림짤은 몰라도 닉짤정도면 누구나 만들수있잖아	김멋져	12.04.11	37	0
310030	나도 짤 만들어쓸까? [2]	생물학(203.226)	12.04.11	38	0
310029	아까 안드로이드 컴파일 할 때 하드디스크 용량 많이 필요한거 안 믿던형 [3]	ㅁㄴㅇㄹ(220.86)	12.04.11	66	0
310028	아까 문제인데 주석달아서 다시올릴게 [2]	하루애(183.108)	12.04.11	38	0
310027	아까 whlie문 관련 질문좀 할게 ㅠㅠ [3]	ㄴㅇㄹ(211.207)	12.04.11	47	0
310025	배열문제 질문. [4]	하루애(183.108)	12.04.11	43	0
310024	어제 나 여기안왔었지?	김멋져	12.04.11	30	0
310022	제발도와주세요 구원을부탁드립니다 ㅠㅠ	고수님들찾음(175.214)	12.04.11	25	0
310021	C++간단한 질문좀 할게 ㅠㅠ [2]	ㄴㅇㄹ(211.207)	12.04.11	36	0
310019	형들아 자바에서 입력 대기(blocking) 되어잇는동안 [7]	zz(211.117)	12.04.11	65	0
310017	형들 좀 도와주세여 ㅠ [10]	hiking	12.04.11	70	0
310015	지금 프로그래머인 형들있나	ㄲㄲ(115.20)	12.04.11	41	0
310013	안녕하세여 뉴비에여 [1]	민이(115.20)	12.04.11	36	0
310012	반 도 안했네 [2]	이모군(175.114)	12.04.11	60	0
310010	땡칠도사 [10]	코드브로커(221.142)	12.04.11	100	0
310009	투표율 70% 설레발이 민망하고 아쉽긴 하지만, 모두 수고했다. [1]	바보플머(218.155)	12.04.11	76	0
310008	다음텀에 3D 그래픽 프로젝트 하는데... [5]	땡칠도사	12.04.11	81	0
310007	해쉬, MD5, SHA-1 등 암호화에 대해 [1]	때릴꺼야?(116.40)	12.04.11	56	0
310006	Cygwin으로 작업중에 중괄호가 안눌러져 [3]	형들아(125.142)	12.04.11	44	0
310005	형들 상담좀해주세요 [4]	숭실대:)	12.04.11	70	0
310003	ㅅㅂ 이거 왜이러는거야 [4]	elwlwlwk	12.04.11	63	0
310001	명령프롬프트 명령어중에 compact좀 알려주세요... [1]	maxam	12.04.11	70	0
310000	형들 이거좀 알려주라ㅠㅠ [9]	아오아(121.155)	12.04.11	83	0
309998	애플 개웃기네 ㅋㅋ. 개발자 등록하려고 99달러 냇는데 [2]	ㅋㅋ(218.37)	12.04.11	119	0
309997	횽들 유닉스 쉘 간단한거 하나만 짜주세요ㅠ [2]	unix(211.245)	12.04.11	48	0
309996	형들이거 병신같이 나오는데 이유가 뭐징? [6]	뇌장애(118.127)	12.04.11	113	0
309995	말 나온김에 , 자바같은걸로 먼저 시작한 횽들'' [5]	ㅋㄱ(183.96)	12.04.11	75	0
309994	c언어,c++몰라도 자바 할수있지? [12]	ㅋㅋㅋ(122.34)	12.04.11	237	0
309993	당신의 소중한 한 표를 펌하하는 조롱에 굴복하지 마라. [3]	바보플머(218.155)	12.04.11	76	0
309992	구로디지털 단지에 있는 오라클자바교육센터 아는사람좀있음?	므해?	12.04.11	39	0
309991	Go programming language [10]	땡칠도사	12.04.11	153	0
309990	자바가 편하긴 마이편한듯.. [3]	zaitsev(211.246)	12.04.11	109	0
309988	c언어 과제 인데 좀 도와주세요; [3]	난바빠(121.148)	12.04.11	105	0
309987	왜 컴파일 하는 동안 디스크 용량이 무쟈게 많이 필요하나요? [2]	ㄴㅇㅁㄹ(220.86)	12.04.11	72	0
309986	형들아 자바에서 [3]	ㅋㅋ123(211.117)	12.04.11	43	0
309985	네이티브한 기능을 구현하고 싶은데 [4]	terapico	12.04.11	59	0
309984	졸업프로젝트 원래 무임승차하는애들 있나? [11]	마타버터	12.04.11	219	0
309981	북한에 퍼주는게 낫냐? 사대강 만드는게 낫냐? [7]	ㅇㅇ(121.133)	12.04.11	97	0
309980	형..배열 완전 기초좀 알려줘..ㅜㅜ [3]	완전초보(112.159)	12.04.11	46	0
309979	파일 분할 하는것좀 알려줘 ㅠㅠㅠ [1]	ㅇ0ㅇ(14.36)	12.04.11	85	0
309977	뇌자극 jsp&서블릿 어떰?	해피너스	12.04.11	41	0
309976	ㅠㅠ 형들아 큰일났다 ㅜㅜ mySQL 암호까먹음 [5]	bb(211.117)	12.04.11	94	0
309975	헤드퍼스트 자바 좋네 [2]	ㅁㄴㅇㄹ(118.60)	12.04.11	78	0