Variables documentation in Scala

Question

I'm new in Scala (I come from Java) and I would like to know how is the correct way to generate documentation for the class variables.

For example, if I have the following code:

class MyClass (bar:bar) {

  val foo = bar

  def function {
      ...
      ...
  }
}

what's the correct way to create the documentation for the variable foo ? Do I just add the comment right before the declaration? Isn't it a bit confusing?

Thanks!

moem · Accepted Answer · 2015-11-13 22:04:32Z

2

You can use Javadoc in Scala. But Scala also introduces its own documentation generator called Scaladoc. This is what is used to generate the standard language documentation.

In general, Scaladoc follows similar conventions to Javadoc but introduces new features. You can read more about Scaladoc comments style here.

answered Nov 13, 2015 at 22:04

moem

5563 silver badges10 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Everv0id · Accepted Answer · 2015-11-13 21:27:03Z

1

There is no difference between java and scala comments. You can choose any documentation strategy you used in java.

answered Nov 13, 2015 at 21:27

Everv0id

1,9823 gold badges25 silver badges50 bronze badges

1 Comment

Alexey Romanov Over a year ago

There is, however, a difference between Javadoc and Scaladoc comments.

Collectives™ on Stack Overflow

Variables documentation in Scala

2 Answers 2

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related