문서 작성은 중요하다.

프로그래밍 갤러리

자동 짤방 이미지

이미지가 없습니다.

자동 짤방으로 사용할 이미지를 등록해 주세요.

1/3

"이런 표현 쓰기 좀 조심스러운데...." ㅇㅇ
???: 레버리지를 장기투자하는 사람이 어딨어요? ㅇㅇ
(ㅇㅎ) AI 버블론에 국장 폭락하는. manhwa 새만화금고
경)대한민국 전기차 시장 사망... 전기차 사지 마라(축 시마시마
경의선 도보답사 탄소다이아
조국 조국혁신당 제3대 대표 선출, 98.6% 득표 ㅇㅇ
스압) 유명 영화 감독들의 시그니처 연출들..jpg 김윾식
尹선고 임박인데 '내란특판' 밀어붙이는 與강경파...당내도 '우려' 실베간
이터널리턴 < 지자체 지원 팬미팅에 선수가 노쇼 ㅋㅋ ㅇㅇ
역적- 10화 수석어시
훌쩍훌쩍 토이스토리 엔딩
뱅드림 팝핀드림 괌 성지순례 여행기 2편 업사다
옳게된 대학 캠퍼스들 ㅇㅇ
“차 사고 여성이 더 위험” 미, 여성형 충돌시험 인형 첫 도입 스탈린
ㅅㄱㅂㄱ 일일 가장의 무게...manhwa 복슬복슬Teemo

싱글벙글 영화 알포인트에서 제일 무서운 것..jpg 그건 바로 주로 촬영지였던 폐호텔보코산 호텔로 유명한 곳이었으며2018년 중국계 자본이 5성급 호텔로 수리함3년 전쯤 국내 모 여행유튜버가 가본 결과 스산한 느낌이라고안개가 안 꼈을땐 이런모습정식명칭은 르 보코르 팰리스의 5성급호텔하지만 한국출신 대학생이 이 호텔이 위치한 산정상에서 고문당하며 죽자지금은 여행경보단계 최고수준인 4단계로 격상되서 못감 작성자 : ㅁㅁ

아놔콘다

2012.04.10 20:22:09

조회 57 추천 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	대학생 필수템! What's in my Bag	운영자	25/11/21	-	-
공지	프로그래밍 갤러리 이용 안내 [97]	운영자	20.09.28	48753	65
2904434	Arduino Due CP/M Personal Computer	발명도둑잡기(118.216)	09:09	8	0
2904433	난 자바를 좋아하는데 [4]	슈퍼막코더(126.179)	09:02	28	0
2904431	중국 놈들이 여론조작하는 거 밝혀짐	프갤러(118.235)	08:42	564	5
2904429	기술적인 얘기인척 하려해도 늘 같은 소리인거 같음 [3]	ㅇㅇ	08:14	39	2
2904427	모바일 SDK 개발하는 팀은 어떤일해?	프갤러(220.92)	07:37	12	0
2904426	cyber security능 끝물이공 버려진field잉	무토깽(218.149)	07:24	17	0
2904425	러스트는 GUI부터 제대로 제공해야 됨 [1]	ㅇㅇ(114.30)	06:48	32	0
2904422	요즘은 관리잘하면 50초중까지는 꼴리는듯	ㅇㅇ(118.235)	06:25	29	0
2904421	인지과학조져라	손발이시립디다	06:13	29	0
2904420	발명도둑잡기 차단이 왜 풀려있냐?	ㅇㅇ(114.30)	06:11	20	0
2904418	중국인 댓글부대 한국여론조작 포착 [1]	♥냥덩이의우웅한하룽♥	06:07	31	0
2904415	kqueue와 epoll의 시스템 아키텍처 및 설계 철학 비교	나르시	05:46	24	0
2904410	33살 중소3년차 똥통인생 이스펙으로 중견입사 가능하냐..?	ㅇㅇ(118.235)	04:59	39	0
2904408	지잡대 졸업 30살인데 학벌 세탁원하는데 학사편입vs대학원	ㅇㅇ(203.232)	04:30	21	0
2904407	Claude cli 오늘 첨 써봤는데 개발자 왜 필요하냐	프갤러(101.235)	04:26	33	0
2904389	Clair.IO.Poller: 이번에 설계했다가 gg친 API ㅋㅋ [1]	나르시	02:59	40	0
2904375	진짜 프로그래머들 ㅈㄴ부럽다 [3]	ㅅ스맨	02:18	100	0
2904367	코딩 걍 첨부터 막히는데 어캄 [2]	ㅅ스맨	01:54	69	0
2904364	자바 언어 좋지.. 추억과 낭만이 깃들인 언어 ㅋㅋ [3]	나르시	01:45	59	0
2904363	거래소 api들 잘 다루고 싶으면 뭐 부터 배우면 될까요 선배님들 [2]	프갤러(114.204)	01:43	50	0
2904359	0x [1]	루도그담당(58.233)	01:22	37	0
2904358	접시 ㅇㅅㅇ [6]	헤르 미온느	01:12	70	0
2904357	태연 ㅇㅅㅇ	헤르 미온느	01:09	26	0
2904356	하루 한 번 헤르미온느 찬양	헤르 미온느	01:08	45	0
2904324	오픈소스 프로젝트를 하나 해볼까 [12]	에이도비	00:02	109	0
2904320	고 언어 음 좋지 나쁘지 않고 효율적이고 음 근데 [6]	프갤러(110.8)	11.23	68	0
2904316	www.basic4mcu.com 11월까지 서비스 종료	발명도둑잡기(118.216)	11.23	21	0
2904313	카리나가 맛집이넹	♥냥덩이의우웅한하룽♥	11.23	82	0
2904309	그러고 보니 프갤에서 고랭 팬은 못본거 같은데 [5]	chironpractor	11.23	58	0
2904303	클라우드 엔지니어 희망하는데 [2]	프갤러(118.235)	11.23	45	0
2904298	cursor 대체할만한거 있어? [2]	ㅇㅇ(124.48)	11.23	55	0
2904295	개발만한 취미가 없는 것 같음	프갤러(61.73)	11.23	67	0
2904294	살면서 잘 한 일... 후배한테 노트북 키스킨 딱 맞는 카라스스킨 5천원	넥도리아(220.74)	11.23	20	0
2904291	에구궁.. 나님 일욜밤까지 모임하구와서 배불러양 [2]	♥냥덩이의우웅한하룽♥	11.23	66	0
2904289	웹디자인은 이미 AI때문에 망한듯 [1]	프갤러(220.70)	11.23	52	0
2904285	왜 극좌들은 하나같이 왕따 당하는걸까? [4]	♥냥덩이의우웅한하룽♥	11.23	51	0
2904266	인공지능 댓글 검사기	발명도둑잡기(118.216)	11.23	30	0
2904265	배달기사 레전드네 진짜; [7]	루도그담당(58.233)	11.23	83	0
2904264	[긴급속보] 한국 연구진이 노벨상 근거를 뒤집자 현재 난리난 천문학계	발명도둑잡기(118.216)	11.23	32	0
2904262	왕따재명 안쓰럽네 ㅠ ㅅ ㅠ [2]	♥냥덩이의우웅한하룽♥	11.23	52	1
2904261	소프트웨어 이름으로 이렁 거 어때? [4]	나르시	11.23	61	0
2904259	긴sql도 셸스크립트도 보기 싫은데 [10]	슈퍼막코더(116.64)	11.23	73	0
2904256	이거 이직 중인데 두개중 어디가야하노 [2]	프갤러(58.231)	11.23	47	0
2904255	베린이평가좀 [1]	ㅇㅇ(39.7)	11.23	58	0
2904247	간철수도 어셈블리어한다는데 [2]	타이밍뒷.통수한방(1.213)	11.23	71	0
2904245	국비조언좀요 [2]	프갤러(220.86)	11.23	65	0
2904244	어셈 짜는 중인데 헷갈린다 이기 [12]	루도그담당(58.233)	11.23	98	0
2904243	폴리글랏 툴체인이 나오면 프갤에 평화가 오려나? [10]	chironpractor	11.23	71	0
2904242	베이스 ㅍㅌㅊ?	ㅇㅇ(203.232)	11.23	55	0