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

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

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

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

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

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

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

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

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



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

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

Jaxp 같은거 한 번 보셈.

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


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

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

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



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