더 많은 사람들이 javadoc.io를 사용합시다!

2574 단어 Scala자바Groovy


자바도 c. 이오 라고 하는 서비스가 훌륭하다고 생각합니다만, 일본어로의 소개 기사가 별로 없었기 때문에 소개시켜 주었습니다.

자바도 c. 이오란?



Central Maven Repository 에 게시된 프로젝트 문서를 호스팅하는 서비스입니다.
http://javadoc.io/doc/<org>/<artifact>/<version>
라는 URL에 액세스하면 해당 문서를 볼 수 있습니다. 예를 들어 OkHttp의 v3.2.0이면,

와 같은 URL이 되어, 이런 문서(라고 해도 Java 8의 JavaDoc 그 자체입니다만)가 표시됩니다.



좋은 곳


  • Java뿐만 아니라 Scala나 Groovy에도 대응하고 있다.
  • Central Maven Repository에 오르고 있는 프로젝트라면, 어떤 프로젝트의 것도 볼 수 있다.
  • 무료
  • 여러 버전의 문서를 즉시 전환할 수 있습니다.
  • 문서를 Zip에서 다운로드 할 수 있습니다

  • 기존이라면 JavaDoc을 GitHub Pages 등으로 공개하고 있었을지도 모르지만 GitHub Pages에서 공개하는 경우는 GitHub의 후크를 사용하여 JavaDoc을 빌드하고 업로드해야했던 것을 URL 지정 하는 것만으로 문서를 공개할 수 있는 것은 편하고 좋은 것이 아닐까 생각합니다.

    안되는 곳


  • Java의 표준 라이브러리의 문서는 보이지 않는다
  • Kotlin과 호환되지 않는 패턴

  • Sonatype 또는 JitPack 같은 리포지토리도 지원하지 않습니다
  • GitHub의 최신 버전의 문서를 볼 수 없습니다
  • 최초로 문서를 취득하기 위해 표시되지 않고, 한 번 리로드 할 필요가 있다.

  • 라고, 여기 근처일까라고 생각합니다. Kotlin에 대응하거나 Sonatype이나 JitPack에 대응하고 있으면 사용할 수 있는 폭도 넓어집니다만‥.

    그리고 GroovyDoc이 어떤 프로젝트라면 표시되는지 잘 모르겠습니다.

    또, 마지막 문제는 타이틀에 있는 대로, 좀더 모두 자바도 c. 이오

    이것들은 앞으로의 갱신에 기대하고 싶은 곳입니다.

    요약



    Java 프로젝트를 만들면 같은 배지를 놓아두면 편리하지 않을까요. IDE의 보완으로 문서를 보는 것만으로도 라이브러리의 전체 설계가 보이지 않을 수 있으므로 이렇게 문서 전체에 한 번 눈을 통해 두는 것이 중요하다고 생각합니다. 그러면, 이런 스쿠쇼로 양을 오마화한 기사에 교제해 주셔서 감사합니다.

    좋은 웹페이지 즐겨찾기