PEBKAC #7783

Il y a quelques années, chez un précédent employeur, un collègue demande un détail sur les paramètres d'une API de notre framework maison. Nous lui répondons « Javadoc ! », suite à quoi il pique une crise, disant qu'il est honteux que personne ne veuille faire un effort pour l'aider alors que l'on fait partie de la même entreprise, etc.

Finalement, une voix s'élève :
- Le paramètre xyz est obligatoire, et doit contenir l'une des valeurs suivantes sous la forme d'un String de 4…
- Ah et bien tu vois, ça n'était pas si compliqué que ça de me répondre !
- … Je suis en train de te lire la Javadoc.
PEBKAC.

PEBKAC #7783 proposé par rtfm le 13/05/2013 | 16 commentaires | 👍🏽 👎🏽 +286

bien le pseudo :)
faudrait avoir des tshirt RTFM au boulot.

Commentaire #92356 écrit par root le 13/05/2013 à 17h38 | 👍🏽 👎🏽

Sinon peut-être que tout le monde ne connais pas Javadoc (genre moi par exemple).
Je ne sais pas si pour un développeur c'est une compétence obligatoire (surtout s'il n'a jamais fait de Java) ?
Mais bon, j'aurais compris un "RTFM" plutôt que "Javadoc", donc j'imagine que dans l'autre sens ça doit marcher.

Commentaire #92360 écrit par Woofy le 13/05/2013 à 17h51 | 👍🏽 👎🏽

Javadoc est vraiment la base pour les dev Java. Au départ, c'est le nom d'un outil qui permet de générer un paquet de fichiers HTML de documentation à partir des sources commentés. Maintenant, ça représente aussi les fichiers générés.

Par exemple, la javadoc pour les API de base de Java SE 7 : http://docs.oracle.com/javase/7/docs/api/

Commentaire #92366 écrit par Acné le 13/05/2013 à 18h20 | 👍🏽 👎🏽

Et puis les IDE spécialisés (Eclipse en tout cas) l'affichent lorsqu'ils font de l'autocomplétion.

Commentaire #92368 écrit par BSK le 13/05/2013 à 18h37 | 👍🏽 👎🏽

Kamasutra. The Fucking Manual.

Commentaire #92377 écrit par Pyrhan le 13/05/2013 à 19h58 | 👍🏽 👎🏽

@BSK
Seulement si tu as pris la source avec.

Commentaire #92379 écrit par mini le 13/05/2013 à 20h10 | 👍🏽 👎🏽

Il me semble que Eclipse peut avoir sa javadoc indépendante.
Ici c'est une API maison, donc il est fort probable que la source soit disponible. Si ce n'est pas le cas, c'est con : le code est la meilleur doc…

Commentaire #92388 écrit par BSK le 13/05/2013 à 23h09 | 👍🏽 👎🏽

RTFC : Read The F..ing Code ;)

Commentaire #92389 écrit par spidermoon le 13/05/2013 à 23h38 | 👍🏽 👎🏽

on voit qu'il y a une bonne éthique de boulot chez toi,
parce que chez nous, faut s'accrocher pour avoir une javadoc
c'est plutôt read the fuckin' code (la javadoc des devs hardcores :p)

Commentaire #92402 écrit par foducool le 14/05/2013 à 09h19 | 👍🏽 👎🏽

Et puis sinon, quand on a les sources, un nom de méthode (ou de classe) bien explicite fait les 3/4 du travail ...

Commentaire #92414 écrit par mini le 14/05/2013 à 09h46 | 👍🏽 👎🏽

"Le paramètre xyz est obligatoire, et doit contenir l'une des valeurs suivantes sous la forme d'un String de 4..."
Ca fait longtemps que je n'ai pas fait de Java, il n'y a pas de type énumération dans ce langage ? Ce serait quand même un poil plus propre quand on attend une valeur parmi une liste bien précise.

Commentaire #92422 écrit par Acorah le 14/05/2013 à 10h17 | 👍🏽 👎🏽

RTFRFC : Read The Fucking RFC

Commentaire #92427 écrit par BSK le 14/05/2013 à 10h35 | 👍🏽 👎🏽

C'est vrai que getFuckingPhone est explicite :)

Commentaire #92467 écrit par spidermoon le 14/05/2013 à 16h04 | 👍🏽 👎🏽

Les énumérations sont apparues dans Java 5 pour la première fois.

Commentaire #92468 écrit par spidermoon le 14/05/2013 à 16h07 | 👍🏽 👎🏽

Tant que toutes les variables et fonctions ne s'appellent pas Roxanne[n°]... ^^

Commentaire #92494 écrit par Woofy le 14/05/2013 à 18h06 | 👍🏽 👎🏽

Acorah : je n'allais pas non plus donner le détail complet et réel de l'API (et ça remonte à qq temps)... Malgré ça, un ami m'a -depuis- demandé si c'était moi qui était caché derrière cette anecdote.

Concernant la Javadoc, c'était obligatoire : elle servait de seule et unique référence pour le client à qui on livrait l'API...

Commentaire #92605 écrit par RTFM le 15/05/2013 à 15h04 | 👍🏽 👎🏽