Scala has ported the idea of JavaDoc and creatively called it ScalaDoc
. Adding ScalaDoc to your Scala source works similarly to adding JavaDoc, and is done with markup in comments (see Figure 5-1). For example, the following fragment in source code
/** Returns `true` if this value is equal to x, `false` otherwise. **/
def ==(x: Byte): Boolean
…can be turned into the following fragment in HTML
:
Figure 5-1
Embedded ScalaDoc markup gets rendered in HTML
To see the documentation for the Scala Library API, head ...
