Documentation: Difference between revisions

Scala contribution added.
(Scala contribution added.)
Line 1,397:
# :include:boilerplate.txt</lang>
 
=={{header|Scala}}==
Excellent documentation about ScalaDoc is given [https://docs.scala-lang.org/style/scaladoc.html here in the Scala Style Guide.]
<lang Scala>/**
* This is a class documentation comment. This text shows at the top of the page for this class
*
* @author Joe Schmoe
*/
class Doc {
/**
* This is a field comment for a variable
*/
private val field = 0
 
/**
* This is a method comment. It has parameter tags (param) and a return value tag (return).
*
* @param num a number with the variable name "num"
* @return another number
*/
def method(num: Long): Int = {
//...code here
???
}
}</lang>
=={{header|Smalltalk}}==
(Squeak/Pharo)
<lang smalltalk>FooClass comment: 'This is a comment ....'.</lang>
FooClass comment: 'This is a comment ....'.
</lang>
 
=={{header|SQL PL}}==
Anonymous user