saveourtool/diktat

False positive `KDOC_WITHOUT_RETURN_TAG` for functions returning `Unit` (implicit) or `Nothing` (explicit)

Open

#1406 aperta il 27 giu 2022

Vedi su GitHub
 (2 commenti) (0 reazioni) (1 assegnatario)Kotlin (40 fork)github user discovery
buggood first issue

Metriche repository

Star
 (571 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

DiKTat should require no @return tags in KDoc comments for expression-body functions with an implicit Unit or an explicit Nothing return types. In the below cases, a KDoc without any @return tag is sufficient:

/**
 * This function does nothing.
 */
fun f1() = Unit

/**
 * This function does nothing.
 */
fun f2() = kotlin.Unit

/**
 * This function fails immediately.
 */
fun fail1(): Nothing = TODO()

/**
 * This function fails immediately.
 */
fun fail2(): kotlin.Nothing = TODO()

Environment information

  • diktat version: 1.2.0
  • build tool (maven/gradle): Maven
  • how is diktat run (CLI, plugin, etc.): Maven plug-in
  • kotlin version: 1.7.0
  • operating system: Windows

Guida contributor

Direzione di ricerca
Esamina l'implementazione della regola KDOC WITHOUT RETURN TAG per identificare perché i tipi di ritorno Unit e Nothing causano un falso positivo. Controlla la logica che determina quando è richiesto @return e considera l'aggiunta di eccezioni per Unit implicito e Nothing esplicito.
Tech stack
kotlin
Dominio
tooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Kotlin
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70