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

标签 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
}

是合法的代码,所以我不能明确地引用它。

是否有一些约定,这应该是什么样子?

最佳答案

艰难的。也许像英语,如 Foo's foo ?我错过了 # 的歧义.不过,这仍然是我的首选,因为歧义只存在于没有上下文的情况下。引用类型时,#有一个意思。引用值或方法时,#有另一个。

由于类型和方法/值不共享命名空间,因此我认为此处不存在相关性的歧义。

关于class - 如何在文档中引用实例方法?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/6973019/

相关文章:

javascript - indexOf 取决于两个键

c++ - 将我的对象声明为 'extern' 会出现 "storage class specified"错误

ruby - 访问模块方法最佳实践( '.' 与 '::')

scala - 建立多用户大网站的建议(1. scala lift/spring roo 2. 数据库 mongoDB/Postgre ORM/MySql ORM 3. Web 服务器环境 Tomcat 等..)

c# - 我需要一个解决方案来消除类中的公共(public)字符串

Scalajs WebGL "Hello World!"

Mongodb scala 驱动程序不插入一个文档

Java - 如何对这个 ArrayList 进行排序?

python - 从命令行调用 Python 类方法

C++ 类 - 指针问题