JavaSearch : moteur de recherche dans la Javadoc

Posté par  . Modéré par rootix.
Étiquettes :
0
11
août
2004
Java
La documentation javadoc de l'API J2SE est bien faite et plutôt claire. Mais il n'existait jusque là aucun outil permettant aux développeurs d'effectuer des recherches parmi les 2723 classes qu'elle compte, dans sa version 1.4.2.

L'outil JavaSearch vient d'être mis en ligne : il propose de lancer des recherches en plein texte dans les descriptions, sur les noms de packages, de classes, de méthodes et de constructeurs. Cet outil est très rapide et pertinent. Il indexe les 200 Mo de fichiers HTML de la Javadoc J2SE 1.4.2

Ce moteur de recherche répond à un énorme besoin des développeurs Java, toujours à rechercher la documentation sur une méthode dont on a oublié le prototypage.

Ce service est hébergé par Developpez.com, site d'entraide des développeurs francophones. Comme tout programmeur Java, j'ai régulièrement besoin de me plonger dans la documentation, généralement à la recherche d'une méthode dont j'ai oublié les subtilités.

Las d'utiliser Google ou la fonction « Rechercher » de mon navigateur pour trouver le bon mot dans la liste des 2700 classes, j'ai décidé d'indexer la totalité de la documentation Java pour créer un moteur de recherche rapide et simple.

La base de données http://javasearch.developpez.com, c'est donc :

* 135 packages
* 2723 classes
* 3348 constructeurs
* 21157 méthodes

Aller plus loin

  • # juste un troll

    Posté par  (site web personnel) . Évalué à -10.

    vive le rebol .....
  • # police du texte à rechercher

    Posté par  . Évalué à 3.

    dans la textbox, là, ça risque d'être illisible pour pas mal de monde.

    j'ai essayé margin par exemple, ça apparait très tassé.

    (configuration : Firefox/win32)
  • # Il est distribué, ce moteur ?

    Posté par  (Mastodon) . Évalué à 7.

    C'est chouette et rapide, et je vois tout de suite l'intérêt pour le code Java développé par les collègues. Mais est-il disponible, ce moteur de recherche spécialisé dans la JavaDoc ?
    Si oui, où et à quelles conditions ?
  • # jdocs.com

    Posté par  . Évalué à 7.

    Un peu à côté du sujet : à noter l'apparition d'un site entièrement consacrée aux docs java: www.jdocs.com
    Au menu, quelques javadocs tirées des dizaines de librairies courantes (les librairies apche commons (collections, digester) , cglib, log4j, struts, spring, jUnit, castor mais aussi j2se et pas mal d'autres). Au total, je crois une 50aine de docs
    Un plugin pour firefox/mozila.
    Il semble qu'il y ait une recherche "dans toutes les doc" (chouette! enfin pouvoir comparer les différents StringUtils...)
    Et des annotations.(comme sur php.net ou mysql.org)

    Bref, tout ce qu'en temps normal un développeur java a sur son poste est mis ici en commun avec quelques fonctionnalités en plus. C'est un bel exemple d'application web et de mise en réseau.

    Je n'ai pas encore eu le temps de pratiquer mais ça a l'air sympathique :-)
  • # Logiciel libre ?

    Posté par  (site web personnel) . Évalué à 1.

    Je suis le seul à pas voir le rapport avec le logiciel libre ? Ou alors j'ai raté quelquechose ? J'ai pas vu spécialement de référence à la licence du moteur sur la page JavaSearch, mais j'ai peut-être mal cherché.
    • [^] # Re: Logiciel libre ?

      Posté par  . Évalué à 1.

      Vu le nombre de logiciels libres développés en Java, je ne vois pas ce qui te choque. ( saxon ( http://saxon.sourceforge.net/(...) ) , les logiciels apache group, le magnifique Jmol http://jmol.sourceforge.net/(...) , etc ...)
      De plus, avec l'apparition des java-gnome et compagnie ( http://java-gnome.sourceforge.net/(...) ) , cela devient de plus en plus pertinent.
      • [^] # Re: Logiciel libre ?

        Posté par  (site web personnel) . Évalué à 1.

        J'ai pas dit que l'outil était inutile. Mais cette news ne concerne que les programmeurs java, et n'a effectivement rien à voir avec le logiciel libre.
        Certes, on peut faire du logiciel libre avec java. Est-ce que c'est une raison suffisante pour faire une nouvelle à chaque nouvel outil en java, libre ou non ?
        • [^] # Re: Logiciel libre ?

          Posté par  . Évalué à 1.

          et est-ce que c'est une raison pour faire une nouvelle a chaques fois qu'un drivers propriétaire sort pour une carte vidéo? On peut en lister beaeucoup comme ca des mauvaises excuses.

          Moi je trouve que si ca s'approche du libre, sans l'etre directement, si ca aide le libre a avancer, ben on fait bien d'en parler...
  • # Dans le même genre

    Posté par  . Évalué à 6.

    J'utilise http://javadocs.org/(...) .

    Avec un bookmarklet adequat c'est vraiment très pratique.
    • [^] # Re: Dans le même genre

      Posté par  . Évalué à 3.

      À première vue je préfère javadocs.org à javasearch, parce que le 1er renvoie directement sur la doc du site de Sun.

      Mais il manque un truc très important : indexer les versions antérieures de Java. Eh oui, tout le monde n'est pas à la pointe de la technologie et il y a des développeurs (moi au hasard :) qui développent pour J2SE < 1.4.2 ou J2EE < 1.4 .

      Ce serait donc cool de pouvoir choisir sa version.

      Un bon point pour javasearch, il propose de choisir classe/méthode/constructeur. Il lui manque cependant un choix "tout".
      • [^] # Re: Dans le même genre

        Posté par  . Évalué à 3.

        À première vue je préfère javadocs.org à javasearch, parce que le 1er renvoie directement sur la doc du site de Sun.

        D'autant que Sun demande de ne pas rendre disponible des miroirs Web de la doc HTML sauf autorisation individuelle :

        Documentation Redistribution Policy :
        "Sun's user and programmer documentation for Java platform products and technologies may not be redistributed publicly on CD-ROM or printed in books or on the Internet or by FTP or translated to another language in part or in whole by anyone outside of Java Software."

        Or contrairement à javadocs.org qui renvoi sur le site java.sun.com, developpez.com lui retourne une copie locale.

        http://java.sun.com/docs/search.html(...)
        • [^] # Re: Dans le même genre

          Posté par  . Évalué à 2.

          Je ne parlais pas de l'aspect légal de la chose, dont je ne savais rien. Je trouve simplement qu'il est plus pratique de renvoyer sur le site de Sun puisque c'est là que se trouve la doc. À part les couleurs qui changent, je ne vois pas bien l'intérêt de renvoyer vers une copie locale. Ça risque plutôt de proposer une doc obsolète.
  • # Et pour la doc en local?

    Posté par  . Évalué à 2.

    Il existe rien pour faire une recherche sur la documentation en local en libre?

    Tout le monde n'a pas internet, alors si on me telecharge la javadoc, ca m''est bien utile. Il n'y a plus qu'a l'installer.

    L'annee derniere, j'avais la flemme de chercher un truc pour faire ceci pour mes projets, et je connaissais JCreator (logiciel proprietaire avec une version gratuite) qui proposait ca. D'ailleurs, si je l'utilisais, c'etait bien pour ca.

    Comme je n'ai pas pris, ni eu le temps de chercher, je me suis contente de ca.


    Mais si quelqu'un connait quelque chose d'equivalent en libre, ca m'interesse.
    • [^] # Re: Et pour la doc en local?

      Posté par  . Évalué à 2.

      Salut,

      ce lien va te servir si tu utilises eclipse.

      http://www.crionics.com/products/opensource/eclipse/eclipse.jsp(...)

      C'est la page d'une société Crionics qui a fait des plugins opensource pour eclipse. Je vous conseille d'ailleurs de regarder il y en a de pas mal. Tout en bas rubrique documentation il y a un plugin nommé "Essential APIs & Manuals" (http://www.crionics.com/products/opensource/eclipse/com.crionics.ja(...)) il contient en gros pas mal de javadoc communes sous le format d'aide de eclipse. Ce qui permet de faire des recherche dedans si tu définis un "Search Scope".

      Pour ma part, j'utilise l'aide d'eclipse directement dans firefox, je sais plus ou je l ai configuré. C'est plus pratique.

      @+
      • [^] # Re: Et pour la doc en local?

        Posté par  . Évalué à 2.

        Il fallait que je me mette a Eclipse de toute maniere.

        Merci!
      • [^] # Re: Et pour la doc en local?

        Posté par  (site web personnel) . Évalué à 1.

        Dans Netbeans, tu peux lui indiquer les endroits où tu as ta doc (dans un répertoire, une archive, en http) et l'outil de recherche (Tools/Search javadoc) se fera un plaisir de t'aider à trouver ce que tu cherches.

        Pas besoin de plugin, c'est déjà dedans :)
        • [^] # Re: Et pour la doc en local?

          Posté par  (Mastodon) . Évalué à 2.

          Tu peux lier un projet, des jars... avec leur javadoc sous eclipse et accéder directement au javadoc, sans plugin.
          Mais tu ne peux pas rechercher --> plugin.

          Pour moi c'est un avantage d'eclipse, de pouvoir rajouter une fonctionalité via des plugins. Un développeur C++ qui bosse avec eclipse, ça ne l'intéressera pas vraiment d'avoir un menu Search/Javadoc :-).
    • [^] # Re: Et pour la doc en local?

      Posté par  . Évalué à 2.

      Y'a ça aussi qui peut servir :
      http://www.dfki.de/~beders/apisearch/(...)
      En gros ça te permet de te faire une applet de recherche depuis n'importe quelle javadoc.

      PS : le lien pour télécharger la bête, parceque perso j'avais eu du mal à trouver :
      http://www.gjt.org/servlets/JCVSlet/zip/gjt/org/gjt/monoid/monoid.z(...)
    • [^] # Re: Et pour la doc en local?

      Posté par  . Évalué à 1.

      A priori Classfinder correspondrait à tes besoins : http://www.roblisa.com/classfinder/(...)
    • [^] # Re: Et pour la doc en local?

      Posté par  . Évalué à 2.

      HS par rapport à la question.
      Ce que j'apprécie sur php.net c'est la documentation mais aussi les "notes"/commentaires sur chaque fonction, parce qu'il y a souvent réponse à nos problèmes.

      AHMA, ça serait intéressant que developpez.com ou un autre fasse ce genre principe au lieu de mettre une copie de la javadoc d'un coté, puis les forums de l'autre...
      • [^] # Re: Et pour la doc en local?

        Posté par  . Évalué à 2.

        Oui je pense également que la doc + les commentaires c'est très utile.
        Dans le cas de Java comme dans d'autres (le shell par exemple) il m'arrive souvent de lire la doc, de ne pas avoir la réponse à ma question, et de chercher sur gogole niouzes un exemple. Si on pouvait tout rassembler on gagnerait du temps :)
  • # Avant il y avait Google....

    Posté par  . Évalué à 2.

    Ca peut être remplacer ma technique de recherche dans google :
    "site:sun.com [nom de la classe]"
    Et "j'ai de la chance" / "Recherche" (et on a la doc pour les différents JDK)

    Dans la plus part des cas ca marche. C'est ce que j'ai utilisé quand j'ai voulu comprendre le fonctionnement de javax.swing.text

Suivre le flux des commentaires

Note : les commentaires appartiennent à celles et ceux qui les ont postés. Nous n’en sommes pas responsables.