我正在撰写有关Scala库的文档。当我引用某个包时,我使用String执行此操作,例如"com.my.example"
但更愿意以一种方式执行此操作,如果有任何中断(例如(com.my.example).mkString
),则会出现编译错误。
当然,我的IDE会在重构时提醒我这种情况并建议为我修复这些字符串。我更喜欢依赖编译器而不是IDE。这有可能吗? (在每个要引用的包中创建伪类不是一种选择)。
答案 0 :(得分:1)
编译器不包含注释,因此它不会中断。你需要使用scaladoc而不是scalac。 生成文档时,您将看到已损坏引用的警告。 例如,我故意拼错了不可变的并得到了这个警告:
[warn] C:\...\Foo.scala:4: Could not find any member to link for "scala.collection.ommutable".
关键是用双括号[[]]括起你的引用,例如:
/**
* This is my link [[scala.collection.ommutable]]
*/