How to refer to instance methods in documentation?

Question

How can I refer to an instance field when writing documentation?

Consider this code:

object Foo {
  val foo = 42
}

class Foo {
  val foo = 42
}

In Java, one would use Foo.foo for the "static" method and Foo#foo for the instance method.

But in Scala # is already taken for path-dependent types and

class Foo {
  class foo
  def foo = 42
}

is legal code, so I can't refer to it unambiguously.

Is there some convention how this should look like?

Answer 1

Tough. Maybe English-like, as in Foo's foo? I had missed the ambiguity of #. That is still my preferred choice, though, because the ambiguity only exists in the absence of context. When referring to a type, # has one meaning. When referring to a value or method, # has another.

Since types and methods/values do not share the namespace, I don't see the ambiguity being of relevance here.