¿Cómo hacer referencia a los métodos de instancia en la documentación?

Question

¿Cómo puedo hacer referencia a un campo de instancia al escribir documentación?

consideran este código:

object Foo { 
    val foo = 42 
} 

class Foo { 
    val foo = 42 
} 

En Java, se podría usar Foo.foo para el método de "estática" y Foo#foo para el método de instancia.

Pero en Scala # ya se da por tipos dependientes de la trayectoria y

class Foo { 
    class foo 
    def foo = 42 
} 

es código legal, por lo que no puede hacer referencia a ella de forma inequívoca.

¿Hay alguna convención sobre cómo debería ser esto?

Answer 1

Tough. ¿Tal vez en inglés, como en el Foo's foo? Me había perdido la ambigüedad de #. Sin embargo, esa sigue siendo mi elección preferida, porque la ambigüedad solo existe en ausencia de contexto. Cuando se refiere a un tipo, # tiene un significado. Cuando se refiere a un valor o método, # tiene otro.

Dado que los tipos y métodos/valores no comparten el espacio de nombres, no veo aquí la ambigüedad de relevancia.