Scala Language
anteckningar

Syntax

• @AnAnnotation def someMethod = {...}
• @AnAnnotation class someClass {...}
• @AnnotatioWithArgs (annotation_args) def someMethod = {...}

parametrar

Anmärkningar

Använda en kommentar

Den här exemplaanteckningen indikerar att följande metod deprecated .

@deprecated
def anUnusedLegacyMethod(someArg: Any) =  {
  ...
}

Detta kan också skrivas på motsvarande sätt som:

@deprecated def anUnusedLegacyMethod(someArg: Any) =  {
  ...
}

Kommentera huvudkonstruktören

/**
 * @param num Numerator
 * @param denom Denominator
 * @throws ArithmeticException in case `denom` is `0`
 */
class Division @throws[ArithmeticException](/*no annotation parameters*/) protected (num: Int, denom: Int) {
    private[this] val wrongValue = num / denom
    
    /** Integer number
     *  @param num Value */
    protected[Division] def this(num: Int) {
      this(num, 1)
    }
}
object Division {
  def apply(num: Int) = new Division(num)
  def apply(num: Int, denom: Int) = new Division(num, denom)
}

Synlighetsmodifieraren (i detta fall protected ) bör komma efter anteckningarna i samma rad. Om anteckningen accepterar valfria parametrar (som i detta fall @throws accepterar en valfri orsak) måste du ange en tom parameterlista för anteckningen: () före konstruktörsparametrarna.

Obs: Flera kommentarer kan anges, även från samma typ ( upprepade kommentarer ).

På liknande sätt med en fallklass utan hjälpfabriksmetod (och orsak angiven för anteckningen):

case class Division @throws[ArithmeticException]("denom is 0") (num: Int, denom: Int) {
    private[this] val wrongValue = num / denom
}

Skapa dina egna kommentarer

Du kan skapa egna Scala-anteckningar genom att skapa klasser härrörande från scala.annotation.StaticAnnotation eller scala.annotation.ClassfileAnnotation

package animals
// Create Annotation `Mammal`
class Mammal(indigenous:String) extends scala.annotation.StaticAnnotation

// Annotate class Platypus as a `Mammal`
@Mammal(indigenous = "North America")
class Platypus{}

Annoteringar kan sedan förhöras med reflektions-API: n.

scala>import scala.reflect.runtime.{universe ⇒ u}

scala>val platypusType = u.typeOf[Platypus]
platypusType: reflect.runtime.universe.Type = animals.reflection.Platypus

scala>val platypusSymbol = platypusType.typeSymbol.asClass
platypusSymbol: reflect.runtime.universe.ClassSymbol = class Platypus

scala>platypusSymbol.annotations
List[reflect.runtime.universe.Annotation] = List(animals.reflection.Mammal("North America"))