L’équipe Kotlin sait combien le travail de ces auteurs est essentiel pour chaque utilisateur. C’est pourquoi JetBrains tient à les aider en leur fournissant des outils et de la documentation. L’expérience des auteurs de bibliothèques est l’une des priorités clés pour la feuille de route 2023 de Kotlin.
Dans un billet de blog, JetBrains donne plus de détails sur ses 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, le moteur de documentation d'API pour Kotlin.
Amélioration de l’expérience des auteurs de bibliothèques
JetBrains a 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 d'intégration continue (CI).
Amélioration de l’expérience avec KDoc, le langage utilisé pour documenter le code Kotlin
- 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
- Stabilisation de Dokka avec la sortie HTML.
- Publication d'une nouvelle documentation de Dokka entièrement retravaillée.
Guide de l’API Kotlin pour les auteurs de bibliothèques
- 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.
- Listing des 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
JetBrains introduit une toute nouvelle documentation Dokka. L'éditeur de logiciels pour développeurs a 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.
JetBrains a é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èques et les autres projets concernant Kotlin, consultez la feuille de route de Kotlin.
Consulter la feuille de route de Kotlin