Getting started with Scala Language Functions While Loops Pattern Matching For Expressions Collections Type Parameterization (Generics)Error Handling Extractors Case Classes Traits XML Handling Enumerations String Interpolation Currying Partial Functions Higher Order Function Type Variance Implicits Classes and Objects Operator Overloading Option Class JSON Java Interoperability Regular Expressions Setting up Scala Var, Val, and Def Futures Working With Gradle synchronized Single Abstract Method Types (SAM Types)Streams Parser Combinators Type-level Programming Annotations Macros Type Classes Parallel Collections Recursion Quasiquotes Monads If Expressions Best Practices Scaladoc Self types Type Inference Tuples Testing with ScalaTest Reflection Dependency Injection Handling units (measures)Working with data in immutable style Symbol Literals Operators in Scala Packages User Defined Functions for Hive Dynamic Invocation Continuations Library Scala.js Testing with ScalaCheck Scope scalaz

Scaladoc

Simple Scaladoc to method

/**
  * Explain briefly what method does here
  * @param x Explain briefly what should be x and how this affects the method.
  * @param y Explain briefly what should be y and how this affects the method.
  * @return Explain what is returned from execution.
  */
def method(x: Int, y: String): Option[Double] = {
  // Method content
}

Syntax:

Goes above methods, fields, classes or packages.
Starts with /**
Each line has an starting * proceding with the comments
Ends with */

Parameters:

Parameter	Details
Class specific	_
`@constructor detail`	Explains the main constructor of the class
Method specific	_
`@return detail`	Details about what is returned on the method.
Method, Constructor and/or Class tags	_
`@param x detail`	Details about the value parameter `x` on a method or constructor.
`@tparam x detail`	Details about the type parameter `x` on a method or constructor.
`@throws detail`	What exceptions may be thrown.
Usage	_
`@see detail`	References other sources of information.
`@note detail`	Adds a note for pre or post conditions, or any other notable restrictions or expectations.
`@example detail`	Provides example code or related example documentation.
`@usecase detail`	Provides a simplified method definition for when the full method definition is too complex or noisy.
Other	_
`@author detail`	Provides information about the author of the following.
`@version detail`	Provides the version that this portion belongs to.
`@deprecated detail`	Marks the following entity as deprecated.

Contributors

Topic Id: 4518

Example Ids: 15826

This site is not affiliated with any of the contributors.