'2010/02/20'에 해당되는 글 1건
- 2010/02/20 예제 중심의 API문서 생성기 *공개* (7)
이전 포스트에서 소개했던 Java6을 위한 Exoa를 공개 합니다. http://exoa.postech.ac.kr/ 많이 이용해 주시고 주위분들에게도 많은 소개 부탁드립니다. 추후 더 많은 Library들이 추가될 예정입니다.
프로그래밍 작업에 있어서 예제를 보면서 작업을 하는 것이 매우 효율적이라는 연구들이 많은데 정작 API에 대해서 가장 먼저배울수 있는 자바 Doc등의 API 문서에는 매우 적은 양의 API가 포함되어 있다는 것이다.(저희가 조사한바에 Java6 API 문서는 1% 의 메소드에만 예제가달려 있다.)
수동으로 일일이 메소드들마다 적당한 예제를 찾아 문서에 붙여주는 것은 많은 수고를 필요로 하는 일이다. 그러나 상당한 양의 코드들이 이미 오픈소스 형태로 존재하고 실제로 개발자들은 구글등의 검색엔진을 이용하여 API사용 예제를 검색하는 경우가 많다.
이번에 포항공대 연구팀과 같이 각 API의 적당한 예제를 자동으로 찾아 붙여 주는 방법에 대해 고민하고 있는데 아래 자동으로 생성된 문서의 snapshot을 보여준다.
각 메시지 앞의 막대기는 해당 메소드의 인기도 (얼마나 많은 양의 예제가 존재하는지) 를 보여주어 메소드를 고를때 도움을 준다.
자동으로 찾아진 예제들은 메소드 상세 설명 하단에 2~5개 정도 자동으로 붙게 된다.
이러한 문서에 대해 여러분들의 생각은 어떠세요? 자동으로 예제를 찾아 API 문서에 붙여 주고 이 문서를 개발에 이용하는 것이 도움이 될수 있을까요? 이 문서의 활용도를 높이고 개발에 도움을 주는 다른 아이템이나 정보들은 어떤 것이 있을가요?
Prev
Rss Feed