Les Cast Codeurs en Video

[Emmanuel Bernard]

Hello à tous,

Nous nous lançons dans un nouveau format, la vidéo, tout en gardant l'audio.

Dites nous ce que vous en pensez, tout se trouve dans le channel YouTube des cast codeurs https://www.youtube.com/@lescastcodeurs . Et souscrivez si cela vous plait, ça nous aidera à nous faire connaître à un public différent et plus large.

Emmanuel

[Remi Forax]

Arnaud : "idealement on pourrait importer du code dans la javadoc ..."

  On peut depuis la java 18, c'est la JEP 413, entre autre, on peut importer du code des tests unitaires dans la javadoc comme cela on est sur que le code compile

     https://openjdk.org/jeps/413

Pour moi, si les quarlus, micronaut et eilidon veulent une partie du gâteau de Spring, il va falloir que chacun revoit sa doc.

Je suis d'accord avec le fait que l'on a 4 types de doc, tutorial (beginners guide)l, how-to (je veux faire un truc), meta ("explanation", le pourquoi, la philosophie) et la doc de réference.

Je suis d'accord avec Guillaume que l'overview de la javadoc est souvent négligé (que cela soit l'overwiew au niveau de la classe, du package, du module).

Mais sutout ce qu'il manque c'est des liens, les how-to devrait extensivement référencer la doc méta (le pourquoi), la doc méta devrait référencer la doc de réference, et la doc de réference devrait être auto-générer à partir du code donc javadoc + code des tests unitaires.

Aussi, un truc que mes étudiants disent souvent est que les how-to sont trop écrits pour des grand débutants, et qu'il manque de la doc pour le niveau intermédiaire, pour moi la solution est que le how-to doit référencer la partie meta, qui elle fournie une vue d'ensemble (et comme le dit Emmanuel la doc meta doit prendre partie, c'est le plus gros problème de la doc Spring, on explique les 25 façons de faire même les façons qui n'ont plus lieu d'être depuis 10 ans, au lieu d'expliquer uniquement les façons raisonnables en 2024).

Souvent les projets se concentre trop sur essayer de convaincre les grand débutants (regarder comment mon tuto est super simple) alors que ce qui fait le gros des troupes, ce sont les gens de niveau intermédiaire.

Pour moi la doc la pire est celle de micronaut, car en tant qu'utilisateur tu dois aller chercher ce que tu veux à plein d'endroits différents, par exemple, la doc jakarta sur jax-rs mais en même temps être au courant de là où micronaut décide de fournir sa propre API car en dessous c'est vertx (hello la gestion des threads).

Rémi

---

--
Vous recevez ce message, car vous êtes abonné au groupe Google Groupes "lescastcodeurs".
Pour vous désabonner de ce groupe et ne plus recevoir d'e-mails le concernant, envoyez un e-mail à l'adresse lescastcodeur...@googlegroups.com.
Pour afficher cette discussion, accédez à https://groups.google.com/d/msgid/lescastcodeurs/CAEW2Rj%2BB9etAsWB3fOjh%3DYCTv6sca5MXwg9g5rKD%3DeMS4a%3Dsjw%40mail.gmail.com.