如何在文档中引用实例方法?

时间:2011-08-07 13:05:34

标签: class scala object methods documentation

编写文档时如何引用实例字段?

考虑以下代码:

object Foo {
  val foo = 42
}

class Foo {
  val foo = 42
}

在Java中,可以使用Foo.foo作为“静态”方法,使用Foo#foo作为实例方法。

但是在Scala #已经采用了路径依赖类型和

class Foo {
  class foo
  def foo = 42
}

是合法代码,因此我无法明确地引用它。

是否有一些约定应该如何?

1 个答案:

答案 0 :(得分:3)

坚韧。也许像英语一样Foo's foo?我错过了#的歧义。不过,这仍然是我的首选,因为模糊性只存在于没有背景的情况下。在引用类型时,#有一个含义。在引用价值或方法时,#会有另一个。

由于类型和方法/值不共享命名空间,我不认为这里的歧义是相关的。