티스토리 툴바



2010/02/20 14:43

예제 중심의 API문서 생성기 *공개*

이전 포스트에서 소개했던 Java6을 위한 Exoa를 공개 합니다. http://exoa.postech.ac.kr/  많이 이용해 주시고 주위분들에게도 많은 소개 부탁드립니다. 추후 더 많은 Library들이 추가될 예정입니다.

프로그래밍 작업에 있어서 예제를 보면서 작업을 하는 것이 매우 효율적이라는 연구들이 많은데 정작 API에 대해서 가장 먼저배울수 있는 자바 Doc등의 API 문서에는 매우 적은 양의 API가 포함되어 있다는 것이다.(저희가 조사한바에 Java6 API 문서는 1% 의 메소드에만 예제가달려 있다.)

수동으로 일일이 메소드들마다 적당한 예제를 찾아 문서에 붙여주는 것은 많은 수고를 필요로 하는 일이다.  그러나 상당한 양의 코드들이 이미 오픈소스 형태로 존재하고 실제로 개발자들은 구글등의 검색엔진을 이용하여 API사용 예제를 검색하는 경우가 많다.

이번에 포항공대 연구팀과 같이 각 API의 적당한 예제를 자동으로 찾아 붙여 주는 방법에 대해 고민하고 있는데 아래 자동으로 생성된 문서의 snapshot을 보여준다.



각 메시지 앞의 막대기는 해당 메소드의 인기도 (얼마나 많은 양의 예제가 존재하는지) 를 보여주어 메소드를 고를때 도움을 준다.

자동으로 찾아진 예제들은 메소드 상세 설명 하단에 2~5개 정도 자동으로 붙게 된다.

이러한 문서에 대해 여러분들의 생각은 어떠세요? 자동으로 예제를 찾아 API 문서에 붙여 주고 이 문서를 개발에 이용하는 것이 도움이 될수 있을까요?  이 문서의 활용도를 높이고 개발에 도움을 주는 다른 아이템이나 정보들은 어떤 것이 있을가요?



저작자 표시 비영리 변경 금지
Trackback 2 Comment 7
2010/02/02 22:50

일류 연구실을 꿈꾸며..

이제 홍콩에서 일한지가 일년이 되었고 그동안 이곳에 있으면제 제가 이상한 사람이 아니라는 것을 눈치첸 학생들이 이제 우리 연구실에 들어오려는 시도를 하고 있습니다. 이미 3명의 학생이 저희 연구실에 공부하고 있고 또 학교에 석사/박사로 다른 연구실에서 공부하고 있는 학생들이 우리 연구실로 옮겨 오려는 학생이 3명. 그리고  2010년 가을에 신입생으로 저희 연구실에 지원한 학생도 7명... (이 블로그를 보고 지원한 많은 한국학생들에게 감사를 전합니다.)

저의 시간과 funds에 한계가 있기때문에 저도 좋은 학생만을 받으려고 하고 출신학교를 보고 성적을 보고 어떻게 하면 좋은 학생을 고를수 있을까를 고민하고 있는중에 도올 김용옥 선생님의 대학교육에 대한 쓴소리를 듣게 되었습니다.

(도울 김용옥 선생님의 목소리로 직접 들어야 하는데 유튜브에 있던 비디오는 삭제된것 같습니다.)
영수를 100점 맞는 게들이 좋은 학생이 아니라 그말이예요. 서울대학이 서울대학일 수 있는 훌륭한 이유는 좋은 학생을 뽑는데 있는게 아니라 학생을 훌륭한 학생으로 교육시키고 길러내는데 있는거죠. 누가 들어와도 그런 교육을 받으면 일류가 된다고 하는 그 자신이 있을 때만 그게 일류 대학이란 말이예요.
물론 도올 선생님의 말에 이견이 있을수도 있겠지만 위에서 "대학"을 "연구실" 로 바꾸면 바로 이게 저에게 하는 쓴소리인 것입니다. 그래서 저는 우리 연구실이 정말 좋은 교육과 연구 방향등으로 들어온 학생들이 많이 배우고, 처음보다 휠씬 더 훌륭한 학생이 되어 졸업할수 있을까를 자문하고 있습니다. 

어떻게 해야 할까요?

이런 고민을 하는 저에게 모법을 보여주신 스승님이 한분 계십니다.  대구대학교 총장님을 지내신 이용두 교수님이신데 당시 제가 연구 학생으로 있을때 지도 교수님이셨습니다. 이 교수님을 만난것이 저에게는 큰 행운이었습니다. 저 뿐만 아니라 저희 연구실의 모든 학생들에게 용기를 주시고 (당시 저는 용기가 참 없는 편이었습니다.)  또 그 학생이 잘하는 부분을 잘 발굴해 주셨던 안목을 가지셨던것을 기억합니다. 그리고 학생이 고민하고 있는 문제를 (우리는 교수님에게 이야기 하지도 않았는데) 정확하게 아시고 같이 고민해주시던 모습이 기억납니다.

교수님의 지도 덕분에 당시 같이 연구실에 있었던 선후배들은 모두 훌륭하게 되어 사회에서 각자 맡은일들을 훌륭하게 하고 있습니다.

저도 교수님 처럼 그런 안목을 가져서 학생들에게 용기를 주고, 학생들의 장점을 잘 발굴하여 도울 선생님이 말하는 좋은 학생이 배출되는 그런 일류 연구실을 꿈꿉니다.  2010년 가을 입학을 위해 3월 까지 저의 학교 원서를 모집중입니다. 같이 일류 연구실을 만들어갈 학생들의 지원을 기다립니다.  
저작자 표시 비영리 변경 금지
Trackback 0 Comment 6