Documentación del paquete en Go

Un comentario justo encima de la cláusula package documenta el paquete.

// Package tour modela los tours de práctica de un lenguaje: series en
// orden, cada una con pasos que un jugador escribe por turno.
package tour

// Step es un fragmento dentro de un tour, con la meta de velocidad
// que otorga tres estrellas.
type Step struct {
    Title     string
    TargetTPM int
}

// Tour contiene los pasos de un tour, en orden de juego.
type Tour struct {
    Slug  string
    Steps []Step
}

// Len indica cuántos pasos contiene el tour.
func (t Tour) Len() int { return len(t.Steps) }

Cómo funciona

1. El comentario doc empieza con el nombre del paquete.
2. Los identificadores exportados llevan su propio comentario, que empieza con el nombre.
3. go doc y pkg.go.dev renderizan exactamente esto.

Palabras clave y builtins usados aquí

• func
• int
• len
• return
• string
• struct
• type

El intento, en números

Líneas

19

Caracteres a escribir

498

Tokens

46

Ritmo de tres estrellas

105 tpm

Al ritmo de tres estrellas de 105 tokens por minuto, este intento toma unos 26 segundos.

Escribe este fragmento

Paso 1 de 5 en Paquetes y compilación; paso 21 de 26 en Biblioteca estándar y estructura del proyecto.

← Anterior Siguiente →