한나
2009-05-09 00:18:55
2
5906

예제 중심의 API 문서 생성기


저희가 자바 개발에 도움을 주는 도구를 연구/개발 하는 가운데 여러 개발자님의 의견을 듣고자 글을 올립니다.

 

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

 

이에 저희는 개발자들에게 도움이 되고자 해당하는 API의 예제를 자동으로 검색하여 API 문서에 붙여주는 방법에 대해 연구하고 있습니다.

 

http://ids.postech.ac.kr:8080/exoaExamples/api/ 에서 간한단 에제를 보실수 있습니다. 편의를 위해 이 문서의 스넵샷은 http://farm4.static.flickr.com/3298/3507015519_7a22bb5cd3.jpg 에서 보실 수 있습니다. 각 메시지 앞의 막대기는 해당 메소드의 인기도를 보여주며 예제들은 메소드 상세 설명 하단에 3~5개 정도 자동으로 붙여져 있습니다.

 

이러한 형태의 예제 중심의 API문서가 개발에 도움을 줄 수 있을까요? 혹 이 문서를 개선하시는데 대한 의견이 있으시면 나누어 주세요.

 

감사합니다.

0
0
  • 댓글 2

  • iammine
    2009-05-11 13:32:31
    이제 막 자바개발자 과정을 통해 자바 교육을 받고 있는 제 입장에서 설명드리겠습니다. ^^; 저 역시 어려운 시기에 대량생산되는 자바개발자이기는 하지만...

    자바를 배우는 과정에서 배운 것 이외의 다른 클래스나 메소드들을 사용하기 위해서는 API 문서를 참조하는 과정은 반드시 필요합니다. ^^; 문서를 참조할 때마다 관련한 예제도 있으면 좋지 않을까라는 생각을 계속 해왔습니다. 단순히 API 문서의 설명만 가지고는 그 메소드의 구현방법을 정확하게 이해하지 못할 경우가 많이 있습니다.

    ^^ 한나님이 연구하시는 예제 중심의 API 문서 생성기가 나온다면, 저를 비롯한 다른 개발자들이나 교육생들에게 좋은 참고문헌이 될거라 생각합니다. ^^ +_+)> 제 블로그에서도 말했지만, 꼬옥 만들어 주십시오!!
    0
  • ddakker
    2009-05-11 18:00:00
    Flex API도 보면 이런식으로 되어있어 도움이 많이 됐는데 java도 이런식으로 되면 정말 편리하겠네요.

    의견이라 함은 Flex API같은경우는 예제를 복사해도 붙여 컴파일 하면 바로 실행하여 확인 할수 있습니다. 그래서 핵심적인 부분만 보이는 소스보다 직접 결과물이 나오고 이해 안되면 수정해가며 결과물 확인하면 더욱 이해하기 좋죠^^
    ps. 셈플의 Connection 과같은 경우는 힘들겠지만요.
    0
  • 로그인을 하시면 댓글을 등록할 수 있습니다.