Documentación de Kotlin-Generate Doc para proyectos de Android
Al igual que la herramienta JavaDoc en Java, los funcionarios de Kotlin también lanzaron una herramienta para generar documentación de Kotlin. dokka
Pero realmente no es muy útil.
Error 1: en el momento en que escribí este documento, la última versión de esta herramienta es 0.10.0. En esta versión, el autor fusionó dos complementos (uno para proyectos de Android y otro para proyectos generales de Kotlin). Esto resultó en un gran agujero. Detalles aquí [ /Kotlin/dokka/issues/213(/Kotlin/dokka/issues/213) .
Después de una mañana solucionando problemas, descubrí que después de volver a la versión anterior, no había ningún problema similar en la versión 0.9.17.
Luego, después de sincronizar el proyecto, el complemento agregará una tarea dokka al proyecto.
Pozo 3: se excedió el límite de sobrecarga del GC. Después de resolver el problema anterior, apareció otro problema de habitación. Este problema se considera común, pero no tengo más de diez archivos de clase en total y, de hecho, se anuló. . Bien, configure decisivamente el tamaño de la pila en el archivo gradle.properties en el directorio raíz para expandir el tamaño de la pila
Después de crear con éxito todas las tareas variantes de compilación, finalmente vi que el archivo javadoc aparece en el directorio de salida OutputDirectory carpeta.
Abre la página de índice y podrás ver los documentos generados por dokka para el proyecto.
En la declaración anterior, dokka no generará documentos para clases con androidx como prefijo de nombre de paquete. El problema parece estar resuelto. Pero éste es un método que sacrifica lo cercano por lo lejano. Es como cuando vas a una tienda y quieres comprar una taza de té con leche, el jefe te pregunta qué sabor no quieres beber. . Debido a que puede introducir nuevos paquetes en desarrollos posteriores, dokka puede generar documentos que comiencen con otros registros para otros archivos R. Luego, en este punto, debe continuar agregando la configuración de packageOptions. .