Amélioration de l’expérience des auteurs de bibliothèques !

Read this post in other languages:

Un écosystème de langage de programmation moderne se doit d’être complet en incluant aussi bien des frameworks de tests, que des bibliothèques pour le machine learning et des frameworks de développement web. Ces options sont généralement fournies à la communauté par les auteurs de bibliothèques. 

L’équipe Kotlin sait combien le travail de ces auteurs est essentiel pour chaque utilisateur. C’est pourquoi nous tenons à les aider en leur fournissant des outils et de la documentation. L’expérience des auteurs de bibliothèque est l’une de nos priorités clés pour la feuille de route 2023 de Kotlin.

Dans cet article, nous donnons plus de détails sur nos projets et sur ce qui a déjà été fait à cet égard, notamment en ce qui concerne la mise à jour de la documentation de Dokka.

Amélioration de l’expérience des auteurs de bibliothèques

Nous avons travaillé à la résolution des principaux problèmes liés à la documentation des API publiques, en aidant les auteurs de bibliothèques pour la conception d’API et en fournissant un environnement de développement pratique comprenant les modèles de projets et les scripts de CI. Poursuivez votre lecture pour en savoir plus sur nos projets et n’hésitez pas à participer à la discussion dans les tickets YouTrack dédiés.

Amélioration de l’expérience avec KDoc KT-55073.

  • Amélioration du formatage pour KDoc et les commentaires multilignes.
  • Prise en charge des liens vers des surcharges spécifiques dans les commentaires KDoc.
  • Prise en charge de la mise en évidence et des suggestions d’exemples de code dans les commentaires KDoc.
  • Mise en place d’une inspection pour les commentaires manquants dans KDoc pour l’API publique lorsque le mode explicit-api est activé. 

Version stable de Dokka. KT-48998

  • Stabilisation de Dokka avec la sortie HTML.
  • Publication de la documentation de Dokka entièrement remaniée. 

Guide de l’API Kotlin pour les auteurs de bibliothèques. KT-55077

  • Fourniture d’un guide d’API complet pour les auteurs de bibliothèques.
  • Description des bonnes pratiques pour le développement de bibliothèques JVM et multiplateformes.
  • Lister les outils d’aide au développement de bibliothèques, notamment pour la configuration de projet, la rétro-compatibilité et la publication.

Présentation de la nouvelle documentation de Dokka !

Consultez la nouvelle documentation Dokka et dites-nous ce que vous en pensez. 

Nous avons ajouté des exemples de DSL Groovy pour la configuration de projets Gradle et des exemples pour les projets Maven. pour aider les développeurs qui utilisent ces outils de scripts et de builds.

Nous avons également réorganisé la structure des pages, ajouté des exemples de configurations et fourni des descriptions des options de configuration pour faciliter la prise en main par les utilisateurs débutants. 

Pour en savoir plus sur les améliorations prévues pour les auteurs de bibliothèque et les autres projets concernant Kotlin, consultez la feuille de route de Kotlin.

Voir aussi

 

Article original en anglais de :

Delphine Massenhove

Denis Ambatenne

image description

Discover more