Jak odnieść się do metod instancji w dokumentacji?

Question

Jak mogę odnieść się do pola instancji podczas pisania dokumentacji?

Rozważmy następujący kod:

object Foo { 
    val foo = 42 
} 

class Foo { 
    val foo = 42 
} 

w Javie, można by użyć Foo.foo dla „statycznym” metody i Foo#foo dla metody instancji.

Ale w Scala # jest już zajęta dla typów ścieżek zależne i

class Foo { 
    class foo 
    def foo = 42 
} 

jest kodeks prawny, więc nie mogę się do niego jednoznacznie.

Czy jest jakaś konwencja, jak to powinno wyglądać?

Answer 1

Trudne. Może angielski, jak w Foo's foo? Brakowało mi niejednoznaczności #. To nadal jest mój ulubiony wybór, ponieważ dwuznaczność istnieje tylko w przypadku braku kontekstu. W odniesieniu do typu, # ma jedno znaczenie. Odnosząc się do wartości lub metody, # ma inną.

Ponieważ typy i metody/wartości nie współdzielą przestrzeni nazw, nie widzę tu znaczenia dwuznaczności.