Как ссылаться на методы экземпляра в документации? - PullRequest
Новая
       20

Как ссылаться на методы экземпляра в документации?

6 голосов
/ 07 августа 2011

Как я могу ссылаться на поле экземпляра при написании документации?

Рассмотрим этот код: 

object Foo {
  val foo = 42
}

class Foo {
  val foo = 42
}

В Java можно использовать Foo.foo для «статического» метода иFoo#foo для метода экземпляра.

Но в Scala # уже используется для зависимых от пути типов, а 

class Foo {
  class foo
  def foo = 42
}

является допустимым кодом, поэтому я не могу ссылаться на негооднозначно.

Есть ли какое-то соглашение, как это должно выглядеть?

1 Ответ

3 голосов
/ 07 августа 2011

Tough. Может по-английски, как в Foo's foo? Я пропустил двусмысленность #. Это все еще мой предпочтительный выбор, потому что двусмысленность существует только в отсутствие контекста. При ссылке на тип # имеет одно значение. При ссылке на значение или метод, # имеет другое.

Поскольку типы и методы / значения не разделяют пространство имен, я не вижу здесь двусмысленности, имеющей отношение к делу.

...